post https://{your-domain}.com/customer
Create a new customer
Details
Responses and Response Schema
201 (Customer Created)
Customer created successfully.
| Field Name | Type | Description |
|---|---|---|
| id* | string | |
| url* | string Format: uri | The URI the agent can click on to see the customer. |
| customNonSearchableCustomerFieldOne | string | |
| customNonSearchableCustomerFieldTwo | string | |
| customSearchableCustomerFieldOne | string | |
| customSearchableCustomerFieldTwo | string |
400 (Invalid Field in Payload)
Invalid field in payload. Generic errors.
| Field Name | Type | Description |
|---|---|---|
| fields | obeject | |
| error* | string | The name of the error or code. |
| message* | string | Message passable to the user. |
fields object
| Field Name | Type |
|---|---|
| name* | string |
| errorMessage* | string |
401 (API Key is Invalid)
API key is invalid or has become de-authenticated.
422 (Field Validation Error)
A field validation error has occurred.
| Field Name | Type | Description |
|---|---|---|
| fields | array[object] | |
| error* | string | Name of error or code. |
| message* | string | Message passable to the user. |
fields object
| Field Name | Type | Description |
|---|---|---|
| name* | string | |
| errorMessage* | string | Message passable to the user. |
500 (Unexpected Error)
Unexpected error.
| Field Name | Type | Description |
|---|---|---|
| error* | string | Name of the error or code. |
| message* | string | Message passable to the user. |