Add entity to custom list
URL
POST https://api.complycube.com/v1/customLists/:id/records
Adds an entity (person or company) to the specified custom list.
Headers
Name | Type | Description |
---|---|---|
| string | The content-type must always be set to |
| string | The API |
Path parameters
Name | Type | Description |
---|---|---|
| string | The ID of the custom list. |
Body
Name | Type | Description |
---|---|---|
| string | The type of entity. Valid values are:
1. |
| array | An array of |
| boolean | Indicates whether the entity is active or not. |
| string | The gender. Only applicable when entity type is |
| array | An array of value pair objects covering known associated |
| array | An array of value pair objects covering important dates associated with the entity. Also, see the dates object below. |
| array | An array of strings that contain URIs of images for the entity. |
The name
object
name
object Attribute | Type | Description |
---|---|---|
| string | The entity's first name. This is required when the entity type is |
| string | The entity's middle name. (Optional) |
| string | The entity's last name. This is required when the entity type is |
| string | The entity's company name. This is required when the entity type is |
| string | The entity's name type. Valid values include:
(Optional) |
The countries
object
countries
object Attribute | Type | Description |
|
| The two-letter country ISO code. (Required) |
|
| The entity's country type. Valid string values include:
(Required) |
The dates
object
dates
object Attribute | Type | Description |
|
| The date in a structured format. The date object has the following attributes:
(Required) |
|
| The entity's date type. Valid string values include:
(Required) |
Example request
Example response
Last updated