Skip to main content
PATCH
/
api
/
campaigns
/
{id}
Update a scheduled campaign
curl --request PATCH \
  --url https://your-instance.example.com/api/campaigns/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "message": "<string>",
  "scheduleDate": "2023-11-07T05:31:56Z",
  "isAutopilot": true,
  "process": "<string>",
  "status": "<string>",
  "segmentProcesses": [
    {}
  ],
  "segmentStatuses": [
    {}
  ],
  "segmentSchedules": [
    {}
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "_id": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "message": "<string>",
    "userIds": [
      "<string>"
    ],
    "scheduleDate": "2023-11-07T05:31:56Z",
    "process": "<string>",
    "contactStatus": "<string>",
    "isAutopilot": true,
    "type": "<string>",
    "status": "<string>",
    "createdBy": {},
    "failedUserIds": [
      "<string>"
    ],
    "failedDetails": [
      {}
    ],
    "segmentation": {},
    "assignment": {},
    "rawCsvData": {},
    "stats": {
      "total": 123,
      "sent": 123,
      "failed": 123,
      "successRate": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
name
string
message
string
scheduleDate
string<date-time>
isAutopilot
boolean
process
string
status
string
segmentProcesses
object[]
segmentStatuses
object[]
segmentSchedules
object[]

Response

Campaign updated

success
boolean
message
string
data
object