Order and account emails go out from the store's default transactional sender. When that address cannot send, they go out from the store's Tringify address instead; can_send shows which addresses can send now.
A new customer reply-to address takes effect once its inbox confirms the link Tringify sends to it. Recipients whose mailbox rejected mail permanently, or who reported the store's email as spam, are suppressed; check one address at a time.
Endpoints#
List sender addresses
List the addresses the store sends email from.
can_send reports whether an address can send right now, with the same rule sending enforces. When the default transactional sender cannot send, order and account email goes out from the store's Tringify address.
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
List sending domains
List the store's custom sending domains.
Each domain shows its verification status and whether it can send.
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
Get the customer reply-to address
Get where customer replies to store emails go.
pending_reply_to is an address waiting for its inbox to confirm the link sent to it.
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
Set the customer reply-to address
Set where customer replies to store emails go.
An empty value stops accepting replies. A new address takes effect once its inbox confirms the link Tringify emails to it; until then the response returns it as pending_reply_to.
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Body parameters
| Name | Type | Description |
|---|---|---|
customer_reply_to
required
|
string |
Email address for customer replies, or an empty string. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
-
400EMAIL_REPLY_TO_INVALIDNot a single plain email address.
Check an email suppression
Check whether the store's emails to an address are blocked.
Addresses that bounced permanently or reported the store's email as spam are suppressed. Suppressions are stored as hashes, so they are checked one address at a time.
Query parameters
| Name | Type | Description |
|---|---|---|
email
required
|
string |
The address to check. |
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
-
400INVALID_INPUTNot a single plain email address.
Webhook events#
Subscribe to email_domains/update when a sending domain is verified, fails verification or stops being able to send. emails/bounced and emails/complained report each send's first bounce or spam complaint, with suppressed set when further emails to that recipient now stop.
Sending domain updated
Fired when a sending domain becomes verified or can no longer send email.
Payload fields
| Field | Type | Description |
|---|---|---|
email_domain.id |
string |
Always present |
email_domain.domain |
string |
Selectable in the Payload builder |
email_domain.status |
string |
Selectable in the Payload builder |
email_domain.sending_ready |
boolean |
Selectable in the Payload builder |
email_domain.reason |
string |
Selectable in the Payload builder |
Email bounced
Fired when an email the store sent bounces. A permanent bounce stops further emails to that address until the merchant lifts it.
Payload fields
| Field | Type | Description |
|---|---|---|
email.id |
string |
Always present |
email.type |
string |
Selectable in the Payload builder |
email.recipient_email |
string |
Selectable in the Payload builder |
email.order_id |
string |
Selectable in the Payload builder |
email.bounce_type |
string |
Selectable in the Payload builder |
email.suppressed |
boolean |
Selectable in the Payload builder |
email.occurred_at |
string |
Selectable in the Payload builder |
Email marked as spam
Fired when a recipient marks an email the store sent as spam. Further emails to that address stop.
Payload fields
| Field | Type | Description |
|---|---|---|
email.id |
string |
Always present |
email.type |
string |
Selectable in the Payload builder |
email.recipient_email |
string |
Selectable in the Payload builder |
email.order_id |
string |
Selectable in the Payload builder |
email.bounce_type |
string |
Selectable in the Payload builder |
email.suppressed |
boolean |
Selectable in the Payload builder |
email.occurred_at |
string |
Selectable in the Payload builder |