Update status

View as Markdown

Change the status of a campaign by sending a pause, resume, or cancel action.

Path parameters

org_idstringRequired
workspace_idstringRequired
campaign_idstringRequired

Request

This endpoint expects an object.
actionenumRequired
The new status to set for the campaign

Response

Successful Response
namestring
Name of the resource
campaign_idstring
Unique identifier for the campaign
statusenum
Current status
app_idstring
ID of the agent
created_bystring
User who created this resource
created_atdatetime

Timestamp when the resource was created (ISO 8601)

updated_atdatetime

Timestamp when the resource was last updated (ISO 8601)

descriptionstring or null
Optional description
app_typeenum
Type of agent
app_versioninteger or null
Version of the agent to use
updated_bystring or null
User who last updated this resource

Errors

422
Unprocessable Entity Error