status_changes

Status Changes List

List status change events such as opt-ins and opt-outs

get/status_changes/

Request

  • Base URL: https://api.mainstay.com
  • URL: https://api.mainstay.com/status_changes/
  • Auth: API key in header Authorization

Query parameters

sincestring

Return all messages created since this date.<br />Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

beforestring

Return all messages created before this date.<br />Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

admithub_contact_idstring

Return all messages associated with a specific contact by their AdmitHub ID<br />Can be found in the URL when viewing a contact or a contact's conversations in Mascot<br />https://mascot.admithub.com/contacts/admithub-contact-id OR https://mascot.admithub.com/conversations/admithub-contact-id

contact_crm_idstring

Filter messages based on the CRM ID of the contact associated with the message

test_userstring

Filter messages based on the <code>test_user</code> status of the sender.<br />Must set <code>include_test_user=true</code> with this filter to include test users.

include_test_userstring

If <u>true</u>, include messages from test contacts. Otherwise, these messages are excluded from results.<ul><li>Possible true values: True, true, 1</li><li>Possible false values: False, false, 0</li><li>Default value: False</li><ul>

pageinteger

A page number within the paginated result set.

Response

OK

idstring

Status change event ID

admithub_contact_idstring

Associated contact ID

createdstring date-time

Timestamp of event (UTC)

typestring

Type of event: START, STOP, or PAUSE

sourcestring

Cause of the event

script_idstring nullable

ID of script, if event happened during a script

campaign_idstring nullable

ID of campaign, if event happened during a campaign

Changes

No recorded changes to this operation across all 1 revision of this API.