EmailOptIn v1.2
Opt-in emails are the cornerstone of permission marketing. They ensure that subscriptions are confirmed and genuine.
Opt-in emails are the cornerstone of permission marketing. They ensure that subscriptions are confirmed and genuine.
Send a confirmed opt-in email with a unique link that's automatically generated:
subscriber_id
and list_id
to create a new subscription and send an opt-in email in the same request.subscription_id
to issue (or re-issue) an opt-in email.list_id
, up to a maximum of 10 emails within a 24 hour period. An error will occur if these limits are exceeded.We may request proof of every confirmed opt-in which is manually confirmed
through the Permission Marketing API.
Attribute | Type | Filter | Sort | Description |
---|---|---|---|---|
id | int | Yes | Yes | Unique ID of the resource. |
completed | bool | Yes | No | Whether the opt-in email has been sent. |
confirmed | bool | Yes | No | Whether the subscriber has confirmed the opt-in. |
error | bool | Yes | No | Whether the opt-in encountered an error. |
errortype | enum/null | No | No | An enum of an error, if one occurred. Possible values: 'Failed', 'Blacklisted', 'Hard bounce', 'Soft bounce'. |
list_id | int | Yes | No | Unique ID of the list. |
message_id* | int/null | Yes | No | ID of a message containing the required email link code. If no message_id is specified then the default opt-in email is sent instead. |
redirectionurl* | string/null | No | No | Direct the user to this URL once they have accepted the opt-in. If no redirectionurl is specified the user will see the default confirmation page. |
subscriber_id | int | Yes | No | Unique ID of the subscriber. |
subscription_id | int | Yes | No | Unique ID of the subscription. |
cdate | decimal | No | Yes | Creation timestamp. |
* Currently supports "null" value only. Non-null funtionality may be made available through subsequent releases of PMAPI.
Attribute | Type | Presence | Description |
---|---|---|---|
id | int | Optional | Unique ID of the resource. |
completed | bool | Optional | Whether the opt-in email has been sent. |
confirmed | bool | Optional | Whether the subscriber has confirmed the opt-in. |
error | bool | Optional | Whether the opt-in encountered an error. |
list_id | int | Optional | Unique ID of the list. |
message_id* | int/null | Optional | ID of a message containing the required email link code. If no message_id is specified then the default opt-in email is sent instead. |
subscriber_id | int | Optional | Unique ID of the subscriber. |
subscription_id | int | Optional | Unique ID of the subscription. |
* Currently supports "null" value only. Non-null funtionality may be made available through subsequent releases of PMAPI.
Attribute | Type | Presence | Description |
---|---|---|---|
list_id | int | Optional** | Unique ID of the list. |
message_id* | int/null | Optional | ID of a message containing the required email link code. If no message_id is specified then the default opt-in email is sent instead. |
redirectionurl* | string/null | Optional | Direct the user to this URL once they have accepted the opt-in. If no redirectionurl is specified the user will see the default confirmation page. |
subscriber_id | int | Optional** | Unique ID of the subscriber. |
subscription_id | int | Optional** | Unique ID of the subscription. |
* Currently supports "null" value only. Non-null funtionality may be made available through subsequent releases of PMAPI.
** You must either provide a subscription_id
OR (subscriber_id
AND list_id
). A new subscription is created if you specify subscriber_id
and list_id
- this subscription will be confirmed once the subscriber clicks the opt-in link in the sent message.
Each subscriber can receive 4 opt-in emails per list_id
, up to a maximum of 10 emails within a 24 hour period. An error will occur if these limits are exceeded.
This method is not supported.
This method is not supported.
There are no error codes for this endpoint.
{ "id" : 123456, "completed" : true, "confirmed" : true, "error" : false, "errortype" : null, "list_id" : 123456, "message_id" : null, "redirectionurl" : null, "subscriber_id" : 123456, "subscription_id" : null, "cdate" : 123456, }