Add a new campaign item to a campaign

POST /CampaignItem/{campaignId}

Try it

Add a new campaign item to a campaign

cURL

curl --request POST \
  --url https://api.starleads.co/CampaignItem/{campaignId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "phoneNumber": "<string>",
  "dataBag": {},
  "nextTryDate": "<string>"
}
'

201

{
  "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>"
    }
  ]
}

Authorizations

X-Api-Key · string · header · required

Headers

X-Api-Key · string · required

Api key to pass as a X-Api-Key request header. You can get yours in your profile when authenticated in Starleads

Path Parameters

campaignId · string · required

ID of the campaign.

Body

phoneNumber · string · required

Phone number of the campaign item. It must be unique.

Minimum string length: 1

dataBag · object

The databag refer to the campaign fields. The Databag needs one key / entry per mandatory fields of the targeted campaign.
If one mandatory field is missing from the databag, an error will be returned.
Databag's keys that aren't properties of the targeted campaign will be ignored.
If the campaign has no mandatory fields, this property can be ommited

Show child attributes

dataBag. {key} · string

nextTryDate · string<DateTime format eg : 2023-11-17T12:44:50.809Z> | null

The next date when the number will be called again by Starleads.
If this property is not set (or set to null), it will be setted by default to today.

Response

201

application/json

Created

id · string | null

campaignId · string | null

createdAt · string<date-time> | null

processedAt · string<date-time> | null

lastCallDate · string<date-time> | null

runningStatus · enum<string>

Available options: Pending, Calling, Processed, ProcessingResult, Error

attemptCount · integer<int32>

phoneNumber · string | null

nextTryDate · string<date-time>

dataBag · object

Show child attributes

dataBag. {key} · string

result · object

Show child attributes

result. tag · object

Show child attributes

result.tag. id · string | null

result.tag. name · string | null

result.tag. color · string | null

result. conversation · object

Show child attributes

result.conversation. id · string | null

result.conversation. messages · object[] | null

Show child attributes

result.conversation.messages. timestamp · string<date-time> | null

result.conversation.messages. role · string | null

result.conversation.messages. text · string | null

result.conversation.messages. intent · string | null

result. summary · string | null

result. isSystem · boolean

result. metadata · object

Show child attributes

result.metadata. {key} · string

isArchived · boolean

eventList · object[] | null

Show child attributes

eventList. type · enum<string>

Available options: LaunchCall, ResetCall, EndCall, ProcessingResult, Error, PickUp

eventList. date · string<date-time>

eventList. description · string | null