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.
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.
Contact records are available for approximately three months only, they are useful for tracking your recent sending activity.
subscriber_id
to see all tasks sent to a particular subscriber.task_id
will fetch every contact made by a task.channel
to see all recent contact of that type.Contact is a read-only endpoint. POST, PUT and DELETE methods are not supported.
Attribute | Type | Filter | Sort | Description |
---|---|---|---|---|
task_id | int | Required* | Yes | Unique ID of the task. |
channel | enum | Required | No | Send channel: "email" or "sms". |
subscriber_id | int | Required* | Yes | Unique ID of the subscriber. |
cdate | decimal | No | No | Contact 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.
Attribute | Type | Presence | Description |
---|---|---|---|
task_id | int | Required* | Unique ID of the task. |
channel | enum | Required | Send channel: "email" or "sms". |
subscriber_id | int | Required* | Unique ID of the subscriber. |
*At least one of: task_id
, subscriber_id
must always be present.
This method is not supported.
This method is not supported.
This method is not supported.
There are no error codes for this endpoint.
{ "task_id": 123456, "channel": "email", "subscriber_id": 125543, "cdate": 12345678 }