Create a contact

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

group_id*string

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

phone_numbers*array<>

Items1 <= items

first_name?string

Default""

last_name?string

Default""

email?string

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

Formatemail

Default""

company?string

Default""

prompt?string

Default""

preferred_language?string

Value in

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

gender?string

Optional gender value. Omit it or send an empty string when not specified.

Default""

forwarding_id?|

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

Defaultnull

Response Body

`application/json`

curl -X POST "https://example.com/contacts" \  -H "Content-Type: application/json" \  -d '{    "group_id": "65a1234567890abcdef01234",    "phone_numbers": [      "+12025550123"    ],    "first_name": "Ada",    "last_name": "Lovelace"  }'

{  "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"  }}

Create a contact

Authorization

Request Body

Response Body

201application/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`