DescriptionTOP

Retrieve a specific partner webhook topic by specifying the topicId path parameter. See the available topic ID's here.

DescriptionTOP

Privileges required: campaign:read

Retrieves the email campaign message specified by the campaignId path parameter. The tracking_summary data is current as of the last scheduled update, unless you set updateSummary=true to return updated data.

NOTE: Details of a deleted campaign cannot be retrieved. If a call is made to GET a deleted campaign by its ID, the call will fail and return a 404 Not Found response. You can login to the account to restore the campaign and then retrieve its details.

DescriptionTOP

Retrieves a list of partner webhook topics. Use the subscription_status query parameter to filter the list as follows:

• subscription_status=ALL returns all topics (ALL is the default value if query param not included)
• subscription_status=SUBSCRIBED returns only topics to which I am subscribed
• subscription_status=NOT_SUBSCRIBED returns only topics to which I am not subscribed

Currently, two webhook topics are available: billing tier upgrades (topic 1), and billing tier downgrades (topic 2).

DescriptionTOP

Privileges required: contacts:lists:read

GET a specific contact list (specified using the listId path parameter).

DescriptionTOP

Privileges required: mylibrary:folder:read

Retrieve a specific MyLibrary folder using the folderId path parameter. 

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve a MyLibrary file using the fileId path parameter.

DescriptionTOP

Privileges required: campaign:read

Retrieve an event item by using the eventId and itemId path parameters to specify the event and item. 

DescriptionTOP

Privileges required: campaign:read

Get a specific event object (specified by the event_id path parameter). Properties with a null value are not returned in the JSON response.

DescriptionTOP

Privileges required: campaign:read

Retrieve detailed information about a specific registrant (specified by registrantId) for an event (specified by eventId).

DescriptionTOP

Privileges required: campaign:read

Retrieve a specific promotional code for an event; use the promocodeId and eventId path parameters to specify the code and the event it belongs to.

Response CodesTOP

StructureTOP

Response StructureTOP

Example ResponseTOP

{
    "id":"2",
    "name":"Billing Tier Downgrade",
    "description":"Executes when an account's billing tier is downgraded",
    "is_subscribed":false
}