Skip to main content
PUT
/
customers
/
{id}
Update customer information
curl --request PUT \
  --url https://api.example.com/customers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Acme Corporation",
  "sendingPhoneNumber": "+1234567890",
  "smsMessagingProfileId": "msg_prof_789",
  "smsBearerToken": "sms_token_def"
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "sendingPhoneNumber": "+1234567890",
  "smsMessagingProfileId": "msg_prof_789",
  "smsBearerToken": "sms_token_def",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-03-01T12:00:00Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Unique identifier of the customer to update

Body

application/json

Updated customer information

Request model for updating customer information

name
string

Updated name of the customer organization

sendingPhoneNumber
string

Updated primary phone number for sending messages

smsMessagingProfileId
string

Updated SMS messaging profile identifier

smsBearerToken
string

Updated bearer token for SMS authentication

Response

Customer updated successfully

Represents a customer account within the Sent platform, including messaging channel configurations and credentials

id
string<uuid>

Unique identifier for the customer

name
string

Name of the customer organization

sendingPhoneNumber
string

Primary phone number used for sending messages

smsMessagingProfileId
string

Identifier for the SMS messaging profile

smsBearerToken
string

Bearer token for authenticating SMS requests

createdAt
string<date-time>

Timestamp when the customer account was created

updatedAt
string<date-time>

Timestamp when the customer account was last updated