Request the Cart Link Email Sending
Can be used to send cart link to shopper by email. Usecases:
- Shopper has filled checkout form, but have problem with payment confirmation on mobile device. Subscription stays in "
waiting_for_payment"state. At this point shopper has confirmed phone number and we can send cart link by email, so that shopper can try to make payment from different device.
- In Mexico shoppers will confirm phone number with SMS from multiburo, that's why send cart link by email from the beginning (if for instance user don't receive Optiqa SMS)
Endpoint
POST /api/public/v1/subscriptions/{id}/send_email
Authentication
HTTP Basic Authentication using your API account credentials.
Authorization: Basic <base64(username:password)>
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Subscription ID |
Request Body
None.
Responses
202 Accepted
Email was sent successfully.
{
"message": "Cart link email sent successfully"
}The message is localized based on the merchant's country:
| Language | Message |
|---|---|
| English | Cart link email sent successfully |
| Spanish | Correo con enlace al carrito enviado exitosamente |
| Portuguese | E-mail com link do carrinho enviado com sucesso |
| German | Cart-Link-E-Mail erfolgreich gesendet |
| Italian | E-mail con link al carrello inviata con successo |
| French | E-mail avec lien du panier envoyé avec succès |
401 Unauthorized
Missing or invalid authentication credentials.
{
"errors": [
{
"code": "unauthorized",
"title": "Unauthorized"
}
]
}422 Unprocessable Entity
Returned when:
- Subscription is not found
- Shopper has no email address
- Subscription is in a state that does not allow cart link email sending
{
"errors": [
{
"code": "invalid",
"title": "Email not allowed for subscription in current status"
}
]
}Allowed Subscription States
| State | Allowed for |
|---|---|
waiting_for_payment | All merchants |
draft | Mexican merchants only |
sent | Mexican merchants only |
in_progress | Mexican merchants only |
Note: For Mexican merchants, sending an email to a subscription in
draftstate will automatically transition it tosent.
Updated 6 days ago