Update a contact
Change one contact's name, tags or field values. tags replaces every tag; addTags and removeTags change some (send one way, not both). fields sets only the keys given, and null clears one. Tags are stored lower case, without commas, at most 40 characters each and 50 a contact.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PATCH "https://example.com/workspaces/string/contacts/string" \ -H "Content-Type: application/json" \ -d '{}'{
"contact": {
"id": "string",
"phoneNumber": "string",
"tags": [
"string"
],
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Add or remove tags on contacts POST
Add and remove tags on up to 1000 contacts at once, each named by id or phone number. A reference that matches no contact is ignored. Returns { updated }, the contacts found. Tags are stored lower case, without commas, at most 40 characters each and 50 a contact.
Create a webhook POST
Create an outbound webhook that POSTs workspace events to an https URL. Event keys: conversation.started, conversation.ended, call_log.completed, lead.received, lead.updated, campaign.launched, campaign.scheduled, campaign.paused, campaign.resumed, campaign.completed, campaign.cancelled, campaign.recipient.finished, alert.fired, metric.optimised. Omit events to subscribe to all of them. Returns the signing secret once (deliveries are signed in X-VAI-Signature as t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">); it also stays visible in Settings → Webhooks. Requires workspace-admin.