Get a sender profile
Changed onReads one of your sender profiles.
The document mirrors POST /v3/sender-profiles, with three differences that follow from this being a read rather than a request.
channels.sms is a list. Create takes the one market a profile starts in; a profile can go on to send in several, and this reports all of them, each with its own status.
compliance.brand comes back in full, with inherit saying whose it is. On a request { "inherit": true } carries no data because there is nothing to send; here it carries the data, because the point of a read is to say what the profile actually sends under.
There is no campaigns array. Brand, campaign, and compliance documents are reported at the profile root in compliance. A profile running on your organization's campaign is asked for none of the campaign fields, so compliance.campaign carries { "inherit": true } with no campaign data.
api_key is never returned here. It is shown once, by create.
A profile belonging to another organization reads as 404, not 403: saying which of the two it is would confirm the id exists.
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
Identifier of the profile, as returned by POST /v3/sender-profiles.
Response
The sender profile
Example response
{
"data": {
"channels": {
"sms": [
{
"status": "PROVISIONING"
}
],
"whatsapp": {
"status": "PROVISIONING"
},
"rcs": {
"status": "PROVISIONING"
}
}
}
}Changes
- 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