Skip to main content
PUT
/
v1
/
businesses
/
{businessId}
/
sms
Update SMS configuration
curl --request PUT \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sms_enabled": true
}
'
{
  "sms_enabled": true,
  "sms_stopped": true
}

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ā€‹
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

ā€‹
businessId
string
required

The UUID of the business to update the SMS settings for.

Body

application/json

The SMS configuration status to set for a business.

ā€‹
sms_enabled
boolean

Whether SMS is enabled for this business.

Response

200 - application/json

The SMS configuration status for a business.

ā€‹
sms_enabled
boolean

Whether SMS is enabled for this business.

ā€‹
sms_stopped
boolean

Whether this business has responded to Layer's SMS with "STOP".