Update a contact

Partial update — only included fields are changed.

Authorization

bearerAuth

AuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the SMAO dashboard (Settings → API Keys).

In: header

Path Parameters

contact_id*string

Match^[a-f0-9]{24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Partial update — include only the fields you want to change.

Properties1 <= properties

group_id?string

Match^[a-f0-9]{24}$

phone_numbers?array<>

Items1 <= items

first_name?string

last_name?string

email?string

Email address. Empty string is accepted if you don't have the contact's email.

Formatemail

company?string

prompt?string

preferred_language?string

Value in

"de"
"en"
"fr"
"it"
"de-CH"
"es"
"pt"
"tr"
"sv"
"fi"
"unknown"

gender?string

Send an empty string to clear the value; omit the property to preserve it.

forwarding_id?|

Match^[a-f0-9]{24}$

Response Body

`application/json`

curl -X PATCH "https://example.com/contacts/65f8fa6f1a9d8e0012ab34cd" \  -H "Content-Type: application/json" \  -d '{    "first_name": "Grace"  }'

{  "data": {    "id": "string",    "group_id": "string",    "group_name": "string",    "phone_numbers": [      "string"    ],    "first_name": "string",    "last_name": "string",    "email": "string",    "company": "string",    "gender": "string",    "prompt": "string",    "preferred_language": "string",    "forwarding_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Update a contact

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`