Contacts
Update contact
Performs a partial update of an existing contact identified by contact_id. Only the fields you include in the request body are changed; omitted fields are left untouched. You may update name, email, phone_number, identifier, the structured additional_attributes, and the free-form custom_attributes. The full updated contact is returned in payload.
curl --request PATCH \
--url 'https://api.nabrah.ai/api/ext/omni_v2/contact/<contact_id>' \
--header 'X-API-Key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Sarah Johnson",
"email": "sarah.johnson@example.com",
"phone_number": "+15551234567",
"identifier": "crm-7831",
"additional_attributes": {
"city": "Jeddah",
"country": "Saudi Arabia",
"description": "Upgraded to enterprise plan",
"company_name": "Acme Corp",
"country_code": "SA",
"social_profiles": {
"linkedin": "in/sarahjohnson"
}
},
"custom_attributes": {
"account_tier": "platinum"
}
}'{
"payload": {
"id": 0,
"additional_attributes": {
"city": "string",
"country": "string",
"description": "string",
"company_name": "string",
"country_code": "string",
"social_profiles": {}
},
"availability_status": "string",
"email": "string",
"name": "string",
"phone_number": "string",
"blocked": false,
"identifier": "string",
"thumbnail": "string",
"custom_attributes": {},
"last_activity_at": 0,
"created_at": 0
}
}Authentication
Send your Web API key (prefix nb_) in the X-API-Key header. The key is scoped to one project; the contact must belong to that project.
Partial update semantics
PATCH only changes the fields you send.
Include any subset of name, email, phone_number, identifier, additional_attributes, and custom_attributes. Fields you leave out keep their current values.
nameemailphone_numberidentifieradditional_attributescustom_attributesadditional_attributesStructured profile object with city, country, description, company_name, country_code, and social_profiles.
citycountrydescriptioncompany_namecountry_codesocial_profilesGet a contact_id from the list or search endpoints, or from payload.contact.id when creating a contact.
Authorization
X-API-KeystringheaderrequiredYour workspace API key. Create one in the dashboard under API keys.
Path parameters
contact_idintegerrequiredNumeric identifier of the contact to update.
Obtained from GET /api/ext/omni_v2/contact or GET /api/ext/omni_v2/contact/search (the contact id field).
Body
application/jsonUpdate profile and custom attributes along with core fields.
{
"name": "Sarah Johnson",
"email": "sarah.johnson@example.com",
"phone_number": "+15551234567",
"identifier": "crm-7831",
"additional_attributes": {
"city": "Jeddah",
"country": "Saudi Arabia",
"description": "Upgraded to enterprise plan",
"company_name": "Acme Corp",
"country_code": "SA",
"social_profiles": {
"linkedin": "in/sarahjohnson"
}
},
"custom_attributes": {
"account_tier": "platinum"
}
}Response
Successful Response
application/json
Validation Error
application/json