Create a customer

Fails if any of the contacts already belongs to another customer in the organization: one person is ONE record, and duplicating it splits their history in two.

POST
/v1/customers

Fails if any of the contacts already belongs to another customer in the organization: one person is ONE record, and duplicating it splits their history in two.

Authorization

AuthorizationBearer <token>

The organization API key, sent as Authorization: Bearer <key>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

city?string|null
contacts*array<>

At least one. The first in the list becomes the primary contact.

Items1 <= items
country?string|null
firstName?string|null
lastName?string|null
preferredLanguage?|

Value in

  • "es"
  • "pt"
  • "en"
  • null
summary?string|null
tags?array<string>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/customers" \  -H "Content-Type: application/json" \  -d '{    "contacts": [      {        "identifierType": "whatsapp",        "identifierValue": "string"      }    ]  }'
{  "city": "string",  "contacts": [    {      "displayName": "string",      "id": "string",      "identifierType": "whatsapp",      "identifierValue": "string",      "phoneNumber": "string"    }  ],  "country": "string",  "createdAt": "2019-08-24T14:15:22Z",  "displayName": "string",  "firstName": "string",  "id": "string",  "lastName": "string",  "preferredLanguage": "string",  "summary": "string",  "tags": [    "string"  ],  "updatedAt": "2019-08-24T14:15:22Z"}