Status history

#The LeadStatusTransition object

An actual status change. The allowed statuses depend on entity_kind.

Attributes

• objectstring
  Object type, always message.
• idstring (uuid)
  Opaque, stable message ID. Do not parse its format.
• workspace_idstring (uuid)
  Workspace ID.
• campaign_idstring (uuid)
  Campaign ID.
• lead_idstring (uuid) or null
  The lead's participation ID in the campaign. May be null in campaign or account history.
• entity_kindstring
  Entity kind: lead, campaign or account. Always "lead".
• entity_idstring (uuid)
  The ID of the entity whose status changed.
• entity_revisioninteger
  The entity's record sequence number. Transitions start at 1; the initial snapshot may have revision 0.
• from_statusstring
  The previous public status. Unrecognized values are returned as unknown. Values: new contacted completed replied blocked failed suspended deleted opted_out unknown
• to_statusstring
  The new public status. Unrecognized values are returned as unknown. Values: new contacted completed replied blocked failed suspended deleted opted_out unknown
• reason_codestring
  The reason for the status change. unspecified if unknown. Values: operator_action schedule queue_exhausted recipient_not_found telegram_auth subscription recovery unspecified
• sourcestring
  The record source, or unknown if unavailable. Statistics always use task_states. Values: user system support unknown
• occurred_atstring (date-time)
  When the change occurred.
• recorded_atstring (date-time)
  When the change or initial snapshot was recorded.

#The CampaignStatusTransition object

An actual status change. The allowed statuses depend on entity_kind.

Attributes

• objectstring
  Object type, always message.
• idstring (uuid)
  Opaque, stable message ID. Do not parse its format.
• workspace_idstring (uuid)
  Workspace ID.
• campaign_idstring (uuid)
  Campaign ID.
• lead_idstring (uuid) or null
  The lead's participation ID in the campaign. May be null in campaign or account history.
• entity_kindstring
  Entity kind: lead, campaign or account. Always "campaign".
• entity_idstring (uuid)
  The ID of the entity whose status changed.
• entity_revisioninteger
  The entity's record sequence number. Transitions start at 1; the initial snapshot may have revision 0.
• from_statusstring
  The previous public status. Unrecognized values are returned as unknown. Values: draft scheduled active paused stopped completed archived launching failed paused_no_credits unknown
• to_statusstring
  The new public status. Unrecognized values are returned as unknown. Values: draft scheduled active paused stopped completed archived launching failed paused_no_credits unknown
• reason_codestring
  The reason for the status change. unspecified if unknown. Values: operator_action schedule queue_exhausted recipient_not_found telegram_auth subscription recovery unspecified
• sourcestring
  The record source, or unknown if unavailable. Statistics always use task_states. Values: user system support unknown
• occurred_atstring (date-time)
  When the change occurred.
• recorded_atstring (date-time)
  When the change or initial snapshot was recorded.

#The AccountStatusTransition object

An actual status change. The allowed statuses depend on entity_kind.

Attributes

• objectstring
  Object type, always message.
• idstring (uuid)
  Opaque, stable message ID. Do not parse its format.
• workspace_idstring (uuid)
  Workspace ID.
• campaign_idstring (uuid)
  Campaign ID.
• lead_idstring (uuid) or null
  The lead's participation ID in the campaign. May be null in campaign or account history.
• entity_kindstring
  Entity kind: lead, campaign or account. Always "account".
• entity_idstring (uuid)
  The ID of the entity whose status changed.
• entity_revisioninteger
  The entity's record sequence number. Transitions start at 1; the initial snapshot may have revision 0.
• from_statusstring
  The previous public status. Unrecognized values are returned as unknown. Values: online offline limited banned deleted locked unauthorized paused unknown
• to_statusstring
  The new public status. Unrecognized values are returned as unknown. Values: online offline limited banned deleted locked unauthorized paused unknown
• reason_codestring
  The reason for the status change. unspecified if unknown. Values: operator_action schedule queue_exhausted recipient_not_found telegram_auth subscription recovery unspecified
• sourcestring
  The record source, or unknown if unavailable. Statistics always use task_states. Values: user system support unknown
• occurred_atstring (date-time)
  When the change occurred.
• recorded_atstring (date-time)
  When the change or initial snapshot was recorded.

#The StatusBaseline object

An initial status snapshot. It is not a transition and does not produce a status change event.

Attributes

#Lead status history

GET/v1/leads/{id}/status-history

Actual lead status changes in ascending entity_revision order. The initial snapshot is separate, in meta.baseline. New features are enabled for your organization on request.

Permission

leads:read

Request weight

2

Parameters

• idstring (uuid), pathrequired
  Lead ID.
• 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.

Response

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

The meta field

• baselineobject or null
  An initial status snapshot, or null. It is not a transition and does not prove earlier history.
  Child attributes

  • objectstring
    Object type, always message.
  • workspace_idstring (uuid)
    Workspace ID.
  • campaign_idstring (uuid)
    Campaign ID.
  • lead_idstring (uuid) or null
    The lead's participation ID in the campaign. May be null in campaign or account history.
  • entity_kindstring
    Entity kind: lead, campaign or account. Always "lead".
  • entity_idstring (uuid)
    The ID of the entity whose status changed.
  • entity_revisioninteger
    The entity's record sequence number. Transitions start at 1; the initial snapshot may have revision 0.
  • statusstring
    The public status or completeness state. Unrecognized values are returned as unknown. Values: new contacted completed replied blocked failed suspended deleted opted_out unknown
  • recorded_atstring (date-time)
    When the change or initial snapshot was recorded.
  • provenancestring
    Always baseline: an initial snapshot, not a status change.
• available_fromstring (date-time) or null
  Start of the period covered by the data. null if unknown.
• history_started_atstring (date-time) or null
  When history collection started. Earlier changes are not reconstructed.
• retained_fromstring (date-time) or null
  The beginning of the retained history period, or null if unknown.
• completenessobject
  Data completeness. has_more=false means there are no more pages, not that the history is complete.
  Child attributes

  • statusstring
    complete, partial or unknown. Values: complete partial unknown
  • gapsarray of object
    Up to 50 intervals of possible incompleteness. Up to 50 items.
    Child attributes

    • idstring (uuid)
      Interval ID.
    • fromstring (date-time)
      Start of the interval.
    • tostring (date-time) or null
      End of the interval. null if the interval is not closed yet.
    • statestring
      open, recovering, recovered, unrecoverable or unknown. Values: open recovering recovered unrecoverable unknown
  • gaps_truncatedboolean
    true if there are more than 50 intervals.
  • incomplete_fromstring (date-time) or null
    Earliest boundary of the hidden incomplete intervals. null if there are none.
• observed_atstring (date-time)
  Time the server read the data.

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 permit the operation. A command requires its kind permission.
• 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.

#Campaign status history

GET/v1/campaigns/{id}/status-history

Actual campaign status changes in ascending entity_revision order. New features are enabled for your organization on request.

Permission

campaigns:read

Request weight

2

Parameters

• idstring (uuid), pathrequired
  Campaign ID.
• 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.

Response

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

The meta field

• baselineobject or null
  An initial status snapshot, or null. It is not a transition and does not prove earlier history.
  Child attributes

  • objectstring
    Object type, always message.
  • workspace_idstring (uuid)
    Workspace ID.
  • campaign_idstring (uuid)
    Campaign ID.
  • lead_idstring (uuid) or null
    The lead's participation ID in the campaign. May be null in campaign or account history.
  • entity_kindstring
    Entity kind: lead, campaign or account. Always "campaign".
  • entity_idstring (uuid)
    The ID of the entity whose status changed.
  • entity_revisioninteger
    The entity's record sequence number. Transitions start at 1; the initial snapshot may have revision 0.
  • statusstring
    The public status or completeness state. Unrecognized values are returned as unknown. Values: draft scheduled active paused stopped completed archived launching failed paused_no_credits unknown
  • recorded_atstring (date-time)
    When the change or initial snapshot was recorded.
  • provenancestring
    Always baseline: an initial snapshot, not a status change.
• available_fromstring (date-time) or null
  Start of the period covered by the data. null if unknown.
• history_started_atstring (date-time) or null
  When history collection started. Earlier changes are not reconstructed.
• retained_fromstring (date-time) or null
  The beginning of the retained history period, or null if unknown.
• completenessobject
  Data completeness. has_more=false means there are no more pages, not that the history is complete.
  Child attributes

  • statusstring
    complete, partial or unknown. Values: complete partial unknown
  • gapsarray of object
    Up to 50 intervals of possible incompleteness. Up to 50 items.
    Child attributes

    • idstring (uuid)
      Interval ID.
    • fromstring (date-time)
      Start of the interval.
    • tostring (date-time) or null
      End of the interval. null if the interval is not closed yet.
    • statestring
      open, recovering, recovered, unrecoverable or unknown. Values: open recovering recovered unrecoverable unknown
  • gaps_truncatedboolean
    true if there are more than 50 intervals.
  • incomplete_fromstring (date-time) or null
    Earliest boundary of the hidden incomplete intervals. null if there are none.
• observed_atstring (date-time)
  Time the server read the data.

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 permit the operation. A command requires its kind permission.
• 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.

#Campaign account status history

GET/v1/campaigns/{id}/accounts/{account_id}/status-history

Account history in the selected campaign, without exposing other campaigns. New features are enabled for your organization on request.

Permission

accounts:read

Request weight

2

Parameters

• idstring (uuid), pathrequired
  Campaign ID.
• account_idstring (uuid), pathrequired
  Account ID.
• 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.

Response

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

The meta field

• baselineobject or null
  An initial status snapshot, or null. It is not a transition and does not prove earlier history.
  Child attributes

  • objectstring
    Object type, always message.
  • workspace_idstring (uuid)
    Workspace ID.
  • campaign_idstring (uuid)
    Campaign ID.
  • lead_idstring (uuid) or null
    The lead's participation ID in the campaign. May be null in campaign or account history.
  • entity_kindstring
    Entity kind: lead, campaign or account. Always "account".
  • entity_idstring (uuid)
    The ID of the entity whose status changed.
  • entity_revisioninteger
    The entity's record sequence number. Transitions start at 1; the initial snapshot may have revision 0.
  • statusstring
    The public status or completeness state. Unrecognized values are returned as unknown. Values: online offline limited banned deleted locked unauthorized paused unknown
  • recorded_atstring (date-time)
    When the change or initial snapshot was recorded.
  • provenancestring
    Always baseline: an initial snapshot, not a status change.
• available_fromstring (date-time) or null
  Start of the period covered by the data. null if unknown.
• history_started_atstring (date-time) or null
  When history collection started. Earlier changes are not reconstructed.
• retained_fromstring (date-time) or null
  The beginning of the retained history period, or null if unknown.
• completenessobject
  Data completeness. has_more=false means there are no more pages, not that the history is complete.
  Child attributes

  • statusstring
    complete, partial or unknown. Values: complete partial unknown
  • gapsarray of object
    Up to 50 intervals of possible incompleteness. Up to 50 items.
    Child attributes

    • idstring (uuid)
      Interval ID.
    • fromstring (date-time)
      Start of the interval.
    • tostring (date-time) or null
      End of the interval. null if the interval is not closed yet.
    • statestring
      open, recovering, recovered, unrecoverable or unknown. Values: open recovering recovered unrecoverable unknown
  • gaps_truncatedboolean
    true if there are more than 50 intervals.
  • incomplete_fromstring (date-time) or null
    Earliest boundary of the hidden incomplete intervals. null if there are none.
• observed_atstring (date-time)
  Time the server read the data.

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 permit the operation. A command requires its kind permission.
• 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.