ONonlymonster
auto-message-campaigns

Retrieve the Auto Messages campaigns of an account

Changed on

Rate limit: 5 requests per second

Required permission: auto_messages.view

get/api/v0/accounts/{account_id}/auto-message-campaigns

Request

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

Path parameters

account_idstring required

OnlyMonster account whose campaigns are read.

Query parameters

limitinteger

Items per page (min: 1, max: 100, default: 50).

offsetinteger

Items to skip (default: 0).

include_archivedboolean

Include archived campaigns in the page (default: false). Only archived is affected — paused, unsending and unsent campaigns are always returned.

Response

A page of the account Auto Messages campaigns.

has_moreboolean required

True when more campaigns exist beyond this page.

Example response

{
  "items": [
    {
      "id": "4312",
      "account_id": "12345",
      "action": "send_message",
      "created_by": {
        "id": "42"
      },
      "messages": [
        {
          "price_gross": 9.99,
          "attachments": [
            {
              "id": "1289402"
            }
          ],
          "tagged_platform_account_ids": [
            "67890"
          ]
        }
      ]
    }
  ]
}

Changes