ONonlymonster
auto-message-campaigns

Recall what an Auto Messages campaign has sent

Changed on

Rate limit: 5 requests per second

The campaign stops sending, its queue is cleared, and the messages it delivered within the last 24 hours are taken back out of the fans' chats. Anything older stays: the platform allows no recall beyond that window.

This cannot be undone and it is not limited to campaigns this API created. Any campaign of the account can be recalled, including one a member built in the panel.

Unlike a status change, repeating this request is not always safe: a campaign that is already recalling refuses it. If the answer is 502, read the campaign before repeating — recalling or recalled means the recall started and finishes on its own, while active or paused means it never started and only a repeat performs it. Reading the campaign needs auto_messages.view in addition to auto_messages.edit.

Required permission: auto_messages.edit

post/api/v0/accounts/{account_id}/auto-message-campaigns/{campaign_id}/unsend

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.

Response

The recall was accepted: the campaign stops sending and takes back what it can.

Changes