Update a sender profile
Changed onChanges a profile's own attributes: name, short_name, description and notifications (who is emailed about the profile's events — ORGANIZATION, SENDER_PROFILE, or ORGANIZATION_AND_SENDER_PROFILE).
Only those. A profile's identity, its markets and its compliance each have a sub-resource of their own, because each has its own validation and its own external consequences — a brand change may need re-registering, a market change provisions a sender. Folding them in here would give those fields two writers and no way to say which one wins.
Omitting a field leaves it alone; sending null clears it. Those are different requests, so {} changes nothing and is refused rather than silently accepted — a caller who misspelt every field would otherwise get a 200 and an unchanged profile.
name and short_name cannot be cleared: short_name is the SMS sender id, so a supplied value must be 3–11 characters of letters, numbers and spaces with at least one letter.
Returns the profile as GET /v3/sender-profiles/{id} would, so the result of the change needs no second call to see.
Request
- Base URLhttps://api.sent.dm
- URLhttps://api.sent.dm/v3/sender-profiles/{id}
- Auth
- API key in header x-api-key
- or HTTP bearer
Path parameters
Headers
Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.
Request body
Example request
{
"name": "Example Retail Renamed",
"short_name": "EXMPL",
"sandbox": false
}Response
The updated sender profile
Example response
{
"data": {
"channels": {
"sms": [
{
"status": "PROVISIONING"
}
],
"whatsapp": {
"status": "PROVISIONING"
},
"rcs": {
"status": "PROVISIONING"
}
}
}
}Changes
- info
added the media type
application/jsonfor the response with the status - info
added the optional property
////////////to the response with the status - info
added the optional property
////////////to the response with the status
- info
- info
endpoint added
- info