Sign in
Orders

Manage SMS suppression for an order

This endpoint allows you to stop or start a scheduled follow-up or reminder SMS message from being sent for an order.

put/shop/orders/{orderId}/sms/suppress

Request body

message_type'basket_reminder' | 'basket_follow_up' required

The type of message the SMS message is.

suppressboolean required

Whether the SMS message should be suppressed.

Example request

{
  "suppress": true
}

Response

The SMS message was successfully suppressed

Changes

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