Sign in
Memberships

Send an SMS message for a membership

This endpoint sends an SMS message to a membership's lead member. Currently supports sending billing details request messages.

post/shop/memberships/{membershipId}/sms

Request body

message_type'billing_details_request' required

The type of message to send.

always_sendboolean

If true, send the SMS even if the membership already has a payment method. Defaults to false.

Response

The SMS message was successfully sent

Example response

{
  "data": {
    "from": "Trybe",
    "to": "+447123456789",
    "message_delivered": true,
    "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.