Campaigns

#The Campaign object

Campaign: a sequence of messages that Telegram accounts send to contacts.

Attributes

• objectstring
  Object type, always campaign.
• idstring (uuid)
  Campaign ID.
• workspace_idstring (uuid)
  Workspace the campaign belongs to.
• namestring
  Campaign name.
• statusstring
  Campaign status. An unknown value is returned as unknown. Values: draft scheduled active paused stopped completed archived launching failed paused_no_credits unknown
• first_message_modestring
  Where the first message comes from. Always template in v1: from the campaign template.
• accepts_api_leadsboolean
  Whether the campaign accepts contacts through the API. Always false in v1.
• reasonobject
  Why the campaign is not sending messages right now, if known.
  Child attributes

  • reason_codestring
    Reason code. Values: none schedule_window daily_limit queue_pending telegram_wait account_unavailable account_restricted campaign_paused subscription_inactive manual_hold automation_stopped service_unavailable unknown
  • reason_observed_atstring (date-time) or null
    When the reason was recorded. null if unknown.
  • next_attempt_atstring (date-time) or null
    When the next attempt is expected. null if the time is unknown.
  • requires_customer_actionboolean or null
    Whether someone needs to act in Meliora for sending to resume. null if unknown.
• created_atstring (date-time)
  When the campaign was created.
• observed_atstring (date-time)
  Time the server read the data.

#List campaigns

GET/v1/campaigns

Campaigns in the key's scope, oldest first by created_at.

Permission

campaigns:read

Request weight

2

Parameters

• limitinteger, queryoptional
  Number of objects to return per page. From 1 to 100. Defaults to 50.
• cursorstring, queryoptional
  The next_cursor value from the previous response. Other filters must match the first request.
• workspace_idstring (uuid), queryoptional
  Only objects in this workspace.
• statusstring, queryoptional
  Only campaigns with this status. Values: draft scheduled active paused stopped completed archived launching failed paused_no_credits unknown

Response

A list: object, data (an array of Campaign objects), has_more, next_cursor. See Pagination.

Endpoint-specific errors

• cursor_mismatch: The cursor is corrupted, was issued for a different route or filters, or the key's permissions and scope have changed.
• scope_required: The key does not have permission for this read. Texts also require "Message text" to be enabled.
• not_found: The object was not found or is outside the key's scope. An unknown path also returns 404.
• cursor_expired: The cursor expired: 15 minutes for lists, 30 days for the event feed.

Common errors are described in Errors.

#Retrieve a campaign

GET/v1/campaigns/{id}

A single campaign by ID. A campaign outside the key's scope returns 404, as if it did not exist.

Permission

campaigns:read

Request weight

1

Parameters

• idstring (uuid), pathrequired
  Campaign ID.

Response

Returns a Campaign object.

Endpoint-specific errors

• scope_required: The key does not have permission for this read. Texts also require "Message text" to be enabled.
• not_found: The object was not found or is outside the key's scope. An unknown path also returns 404.

Common errors are described in Errors.