Sign in
Orders

Send an SMS message

This endpoint sends an SMS message to a customer.

post/shop/orders/{orderId}/sms

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 message the SMS message is.

Example request

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

Response

The SMS message was successfully sent

Example response

{
  "data": {
    "order_ref": "TRY00",
    "from": "Trybe",
    "to": "+447123456789",
    "message_delivered": true,
    "price": 4,
    "created_at": "2024-02-02T12:00:00Z",
    "sent_at": "2024-02-02T12:00:00Z"
  }
}

Changes

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