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

Update contact

PATCH /api/v2/contacts/:contact_uuid - Partial update of contact fields. Send at least one recognized field.

PATCH/api/v2/contacts/:contact_uuid

Partial update of contact fields. Send at least one recognized field.

Required scope: contacts (or *).

Path parameters

NameRequiredDescription
contact_uuidYesContact UUID

JSON body

NameRequiredDescription
first_nameNoFirst name
last_nameNoLast name
phone_numberNoPhone number
emailNoEmail address
notesNoContact notes
sourceNoSource label
tagsNoTag array (replaces tags when provided)
curl -s -X PATCH -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "first_name": "Jane",
  "last_name": "Doe",
  "phone_number": "5559876543",
  "email": "jane.doe@example.com",
  "notes": "Updated phone after callback",
  "source": "api",
  "tags": [
    "medicare",
    "hot",
    "callback"
  ]
}' \
  "https://benefitpath.com/api/v2/contacts/c0a80101-0000-4000-8000-000000000001"
{
  "success": true,
  "contact": {
    "contact_uuid": "c0a80101-0000-4000-8000-000000000001",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com",
    "phone_number": "5559876543"
  }
}

See Errors for the standard error envelope and rate limits.