Overview
Receives an external list and processes it.
Endpoint URL
POST https://api.ritabyaire.com/lists/external
Request Parameters (Body)
| Name | Type | Required | Description |
|---|---|---|---|
list | object | Yes | The external list object containing segment details and contacts. |
Example Request Payload
{
"list": {
"segmentName": "string",
"clPropertyId": "string",
"contacts": [
{
"crmId": "string"
}
]
}
}Expected Response
201 Created - External list received and processed, list successfully created.
{
"message": "string",
"data": {
"list": {
"account": "string",
"name": "string",
"size": "string",
"status": "Pending",
"dateCreated": "2019-08-24T14:15:22Z"
}
}
}