Contact v1.2

A contact record is automatically generated when a task sends a message to a subscriber. Failed attempts to contact a subscriber are known as bounces.

What can I do with contact?

Contact records are available for approximately three months only, they are useful for tracking your recent sending activity.

  • Filter by subscriber_id to see all tasks sent to a particular subscriber.
  • Filtering by task_id will fetch every contact made by a task.
  • Filter by channel to see all recent contact of that type.

Contact is a read-only endpoint. POST, PUT and DELETE methods are not supported.

GET /contact or /contact/:id

AttributeTypeFilterSortDescription
task_id
intRequired*YesUnique ID of the task.
channel
enumRequiredNoSend channel: "email" or "sms".
subscriber_id
intRequired*YesUnique ID of the subscriber.
cdate
decimalNoNoContact timestamp.

*At least one of: task_id, subscriber_id must always be present.

The contact resource is a little different to other resources because we don't support the id attribute and the channel filter is required.

HEAD /contact or /contact/:id

AttributeTypePresenceDescription
task_id
intRequired*Unique ID of the task.
channel
enumRequiredSend channel: "email" or "sms".
subscriber_id
intRequired*Unique ID of the subscriber.

*At least one of: task_id, subscriber_id must always be present.

POST /contact

This method is not supported.

PUT /contact or /contact/:id

This method is not supported.

DELETE /contact or /contact/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "task_id":               123456,
    "channel":               "email",
    "subscriber_id":         125543,
    "cdate":                 12345678
}