Sign in
Orders

Preview an SMS message for an order

This endpoint previews an SMS message for an order.

post/shop/orders/{orderId}/sms/preview

Request body

message_type'basket_confirmed' | 'basket_cancelled_with_charge' | 'basket_cancelled_without_charge' | 'basket_reminder' | 'basket_follow_up' | 'pay_by_link_request' required

The type of the SMS message.

Example request

{
  "params": {
    "cancellation_charge": true
  }
}

Response

The preview of the SMS message was successfully retrieved

Example response

{
  "data": {
    "message": "Hi! Your order has been confirmed. We look forward to seeing you on Saturday 3rd February at 12pm.\n"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.