CampaignItem
Add a new campaign item to a campaign
POST
/
CampaignItem
/
{campaignId}
Copy
curl --request POST \
--url https://api.starleads.co/CampaignItem/{campaignId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '{
"phoneNumber": "<string>",
"dataBag": {},
"nextTryDate": "<string>"
}'
Copy
{
"id": "<string>",
"campaignId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"processedAt": "2023-11-07T05:31:56Z",
"lastCallDate": "2023-11-07T05:31:56Z",
"runningStatus": "Pending",
"attemptCount": 123,
"phoneNumber": "<string>",
"nextTryDate": "2023-11-07T05:31:56Z",
"dataBag": {},
"result": {
"tag": {
"id": "<string>",
"name": "<string>",
"color": "<string>"
},
"conversation": {
"id": "<string>",
"messages": [
{
"timestamp": "2023-11-07T05:31:56Z",
"role": "<string>",
"text": "<string>",
"intent": "<string>"
}
]
},
"summary": "<string>",
"isSystem": true,
"metadata": {}
},
"isArchived": true,
"eventList": [
{
"type": "LaunchCall",
"date": "2023-11-07T05:31:56Z",
"description": "<string>"
}
]
}
Headers
Path Parameters
ID of the campaign.
Body
Response
201
application/json
Created
The response is of type object
.
Copy
curl --request POST \
--url https://api.starleads.co/CampaignItem/{campaignId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '{
"phoneNumber": "<string>",
"dataBag": {},
"nextTryDate": "<string>"
}'
Copy
{
"id": "<string>",
"campaignId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"processedAt": "2023-11-07T05:31:56Z",
"lastCallDate": "2023-11-07T05:31:56Z",
"runningStatus": "Pending",
"attemptCount": 123,
"phoneNumber": "<string>",
"nextTryDate": "2023-11-07T05:31:56Z",
"dataBag": {},
"result": {
"tag": {
"id": "<string>",
"name": "<string>",
"color": "<string>"
},
"conversation": {
"id": "<string>",
"messages": [
{
"timestamp": "2023-11-07T05:31:56Z",
"role": "<string>",
"text": "<string>",
"intent": "<string>"
}
]
},
"summary": "<string>",
"isSystem": true,
"metadata": {}
},
"isArchived": true,
"eventList": [
{
"type": "LaunchCall",
"date": "2023-11-07T05:31:56Z",
"description": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.