SetRecipientsStatus

[POST] .../v1/campaign/setrecipientsstatus

Sets sending statuses for recipients campaign Use this batch method when an external sender reports delivery state changes for one or more campaign recipients. The request body is an array of recipient status updates, each item identifies a campaign recipient by id and sets state to New, Sended, Delivered or Error. The array is required and is limited to 250 items; each state value must be in the supported recipient-state range and the method returns row_affected for updated recipient rows. The caller must have marketing campaign edit permission; missing body, oversized arrays, invalid state, denied access, no affected rows, database failures, transaction failures and recipient-status webhook errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id Int64 Required Campaign recipient ID.
state String Required Sending status: New - only added to the list and not sent yet, Sended - message sent, for example to the SMS gateway or Telegram API, Delivered - delivery confirmed if the channel provides feedback, Error - message sending error. Allowed values: New, Sended, Delivered, Error.

Request Example

[
  {
    "id": 10,
    "state": "Sended"
  }
]

Response Parameters

Name Type Description
ids Array of Object IDs of the records actually changed.
row_affected Int64 Number of records actually changed.

Response Example

{
  "row_affected": 1,
  "ids": null
}