Partner API
Create contact
POST /api/v2/contacts - Creates a contact for the agency.
POST
/api/v2/contactsCreates a contact for the agency.
Required scope: contacts (or *).
JSON body
| Name | Required | Description |
|---|---|---|
first_name | No | First name |
last_name | No | Last name |
phone_number | No | Phone number (normalized) |
email | No | Email address |
tags | No | Optional tag list |
notes | No | Contact notes |
source | No | Source label (defaults to api) |
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "5551234567",
"email": "jane.doe@example.com",
"tags": [
"medicare",
"hot"
],
"notes": "Interested in Advantage plans",
"source": "api"
}' \
"https://benefitpath.com/api/v2/contacts"{
"success": true,
"contact": {
"contact_uuid": "c0a80101-0000-4000-8000-000000000001",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_number": "5551234567",
"source": "api"
}
}See Errors for the standard error envelope and rate limits.