Remove a brand document
DELETE/api/v1/sms/brands/{id}/documents/{documentId}
DELETE /sms/brands/{id}/documents/{documentId}
curl -X DELETE 'https://www.unitpost.com/api/v1/sms/brands/sms_123/documents/documentId_123' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'User-Agent: my-app/1.0'Response · 200
{
"object": "sms_brand_document",
"id": "id_123",
"deleted": true,
"file_kept": false
}Remove a document from the brand. Its file is deleted, unless a registration sent it to a regulator (file_kept: kept as the record of what they received). Refused (409 conflict) while a Sender ID registration that sent it is under review. Requires the sms:manage capability.
Parameters2 fields
| Field | Type | Description |
|---|---|---|
idrequired | string · path | — |
documentIdrequired | string · path | — |
Response · 200 fields4 fields
| Field | Type | Description |
|---|---|---|
objectrequired | string | — |
idrequired | string | — |
deletedrequired | boolean | — |
file_keptrequired | boolean | A registration sent this file to a regulator, so it is kept as the record of what they received (not on the brand any more). |
200401403404409422429