Skip to main content
PATCH
Update an existing campaign item

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 | null

Phone number of the item to update. Required if itemId is not provided.

itemId
string | null

Item ID of the item to update. Required if phoneNumber is not provided.

runningStatus
enum<string>
Available options:
Pending,
Calling,
Processed,
ProcessingResult,
Error
dataBag
object | null

The databag refer to the campaign fields. Only the provided keys will be updated.

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

The next date when the number will be called again by Starleads.

Response

Success

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>
channel
enum<integer>
Available options:
0,
1,
2,
3,
4
phoneNumber
string | null
businessId
string | null
nextTryDate
string<date-time>
dataBag
object | null
result
object
isArchived
boolean
eventList
object[] | null
delivery
object