EmailTransaction Endpoint | Sign-Up.to Permission Marketing API

EmailTransaction v1.2

Sends a transactional email to a specified subscriber.

What can I do with emailTransaction?

EmailTransaction can be used to send transactional emails and retrieve information about sent ones.

Issue a POST to send a new transactional email.
Use email or subscriber_id to get all transactional emails sent to a subscriber.

GET /emailTransaction or /emailTransaction/:id

Attribute	Type	Filter	Sort	Description
id	int	Yes	Yes	Unique ID of the resource.
subscriber_id	int/null	Yes	No	Recipient subscriber id.
email	string/null	Yes	No	Recipient email address.
subject	string	No	No	Email subject.
bodyhtml	text/null	No	No	Email html body.
bodytext	text/null	No	No	Email text body.
fromemail	string/null	No	No	Email from address subject (defaults to noreply@).
fromname	string/null	No	No	Email from name (defaults to company name).
completed	bool	Yes	Yes	Whether the opt-in email has been sent.
error	bool	Yes	No	Whether the opt-in encountered an error.
errortype	enum/null	No	No	An enum of an error, if one occured. Possible values: 'Failed', 'Blacklisted', 'Hard bounce', 'Soft bounce'.
cdate	decimal	No	Yes	Creation timestamp.

HEAD /emailTransaction or /emailTransaction/:id

Attribute	Type	Presence	Description
id	int	Optional	Unique ID of the resource.
subscriber_id	int/null	Optional	Recipient subscriber id.
email	string/null	Optional	Recipient email address.
completed	bool	Optional	Whether the opt-in email has been sent.
error	bool	Optional	Whether the opt-in encountered an error.

POST /emailTransaction

Attribute	Type	Presence	Description
subscriber_id	int/null	Required*	Recipient subscriber id.
email	string/null	Required*	Recipient email address.
subject	string	Required	Email subject.
bodyhtml	text/null	Optional**	Email html body.
bodytext	text/null	Optional**	Email text body.
fromemail	string/null	Optional	Email from address subject (defaults to noreply@).
fromname	string/null	Optional	Email from name (defaults to company name).

* Either address or subscriber_id is required.

** Either body_html or body_text must be specified.

PUT /emailTransaction or /emailTransaction/:id

This method is not supported.

DELETE /emailTransaction or /emailTransaction/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id"               : 123456,
    "subscriber_id"    : 123456,
    "email"            : "example@example.com",
    "subject"          : "Example email",
    "bodyhtml"         : "<html><body><h1>Example email</h1><p>Lorem ipsum.</p></body></html>",
    "bodytext"         : "Example email, lorem ipsum.",
    "fromemail"        : null,
    "fromname"         : null,
    "completed"        : true,
    "error"            : false,
    "errortype"        : null,
    "cdate"            : 123456,
}