---
title: "Send an SMS message"
method: POST
path: "/shop/orders/{orderId}/sms"
tags: ["Orders"]
---

# Send an SMS message

`POST /shop/orders/{orderId}/sms`

This endpoint sends an SMS message to a customer.

## Request body

- object
  - `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.
  - `params` SmsMessageParams — The parameters to be used in the SMS message.
    - `cancellation_charge` boolean — Whether there is a cancellation charge for the order.

## Response `201`

The SMS message was successfully sent

- object
  - `data` SmsMessageSummary, required
    - `id` string, object-id, required — The ID of the SMS message.
    - `organisation_id` string, uuid, required — The ID of the organisation the SMS message is associated with.
    - `site_id` string, uuid, required — The ID of the site the SMS message is associated with.
    - `customer_id` string, uuid, required — The ID of the customer the SMS message was sent to.
    - `basket_id` string, object-id, required — The ID of the basket the SMS message is associated with.
    - `order_ref` string — The reference of the order the SMS message is associated with.
    - `from` string, required — The sender of the SMS message.
    - `to` string, required — The recipient of the SMS message. This is a valid mobile number.
    - `message` string, required — The contents of the SMS message.
    - `message_type` 'basket_confirmed' | 'basket_cancelled_with_charge' | 'basket_cancelled_without_charge' | 'basket_reminder' | 'basket_follow_up' | 'pay_by_link_request' | 'billing_details_request', required — The type of message the SMS message is.
    - `message_delivered` boolean, required — Whether the SMS message was successfully delivered.
    - `price` integer, required — The price of the SMS message.
    - `created_at` string, date-time, required — The date and time the SMS message was created.
    - `sent_at` string, date-time, required — The date and time the SMS message was sent.

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.
- `404` — The resource couldn't be found
- `422` — The request didn't pass validation

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)