i EmailOpen Endpoint | Sign-Up.to Permission Marketing API

What can I do with emailOpen?

Opens give you insight into subscribers interactions:

  • Fetch open events for a particular task_id or subscriber_id.
  • Try polling regularly and responding to events as they happen.

Use openAutomation for enhanced, automated functionality.

GET /emailOpen or /emailOpen/:id

AttributeTypeFilterSortDescription
id
stringYes*NoUnique ID of the open event.
subscriber_id

int

Yes*NoID of the subscriber who clicked the link.
task_id

int

Yes*NoID of the task containing the link.
cdate

decimal

NoYesTimestamp at which the subscriber opened the message.

*GET requires at least one of: id, subscriber_id, task_id.

The id attribute is an artificial primary key formed as a composite of task_id, subscriber_id and cdate. Please note that its type is "string".

HEAD /emailOpen or /emailOpen/:id

AttributeTypePresenceDescription
id
stringOptional*Unique ID of the open event.
subscriber_id

int

Optional*ID of the subscriber who clicked the link.
task_id

int

Optional*ID of the task containing the link.

*HEAD requires at least one of: id, subscriber_id, task_id.

POST /emailOpen

This method is not supported.

PUT /emailOpen or /emailOpen/:id

This method is not supported.

DELETE /emailOpen or /emailOpen/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":            "12333_123123123_1379502479",
    "subscriber_id": 123123123,
    "task_id":       12333,
    "cdate":         1379502479
}