Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

Replace contact tags

PUT /api/v2/contacts/:contact_uuid/tags - Replaces all tags on the contact with the provided list.

PUT/api/v2/contacts/:contact_uuid/tags

Replaces all tags on the contact with the provided list.

Required scope: contacts (or *).

Path parameters

NameRequiredDescription
contact_uuidYesContact UUID

JSON body

NameRequiredDescription
tagsYesArray of tag strings
 
curl -s -X PUT -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "tags": [
    "medicare",
    "hot",
    "callback"
  ]
}' \
  "https://benefitpath.com/api/v2/contacts/c0a80101-0000-4000-8000-000000000001/tags"
{
  "success": true,
  "tags": ["medicare", "hot", "callback"]
}

See Errors for the standard error envelope and rate limits.