api access

External API

  1. Home › 
  2. API Access

Save contact information

This API command will store the contact information and return the contact ID. This operation is idempotent. If a contact with the same set of fields and values is saved, the same identifier will be returned.

Optional contact name. If omitted, it is generated automatically by the system

Contact information according to the domain zone scheme

Contact identifier

HTTP ENDPOINT
POST /v1/contacts
EXAMPLE REQUEST: POST /v1/contacts
{
    "details": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "countryCode": "US",
        "city": "New York",
        "address1": "Wall Street 1",
        "zip": "10005",
        "phoneNumber": "+1.23456789",
    }
}
EXAMPLE RESPONSE: HTTP 200 OK
{
    "id": "ABCDEFGHIJ"
}