ONonlymonster
auto-message-campaigns

Start, pause or archive an Auto Messages campaign

Changed on

Rate limit: 5 requests per second

Asking for the state the campaign is already in is accepted and does not change the campaign, but it is not free: the change is carried out again, which is how a change that did not complete is retried. If the answer is 502, repeat the same request to complete the change; after a 204 there is nothing to repeat. Every request, a repeat included, counts toward the rate limit.

Required permission: auto_messages.edit

patch/api/v0/accounts/{account_id}/auto-message-campaigns/{campaign_id}/status

Request

  • Base URL
    https://omapi.onlymonster.ai
  • Auth
    API key in header x-om-auth-token

Path parameters

account_idstring required

OnlyMonster account the campaign belongs to.

campaign_idstring required

Campaign identifier.

Request body

status'active' | 'paused' | 'archived' required

Response

The status was changed and the change was confirmed.

Changes