Agents

Pause a scheduled outbound campaign

Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.

post/workspaces/{workspaceId}/agents/{agentId}/outbound-campaigns/{campaignId}/pause

Request

  • Base URL: https://app.communicate.so/api/v1
  • URL: https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/outbound-campaigns/{campaignId}/pause
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Secure-better-auth.session_token
    • API key in cookie better-auth.session_token

Path parameters

workspaceIdstring required
agentIdstring required
campaignIdstring required

Response

Pause a scheduled outbound campaign

idstring required
workspaceIdstring required
agentIdstring required
namestring required
status'draft' | 'scheduled' | 'paused' | 'sent' required
channel'whatsapp' | 'email' required
audience'all_contacts' | 'manual' required
templateNamestring required
templateBodystring required
recipientCountinteger required
deliveredCountinteger required
readCountinteger required
replyCountinteger required
scheduledAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.