SmsDeleteAgent¶
DELETE sms/agent
Removes a manager-to-sender link. Messages already sent through it keep pointing at it, so history still shows which sender identity was used.
The link is soft-deleted: linking the same manager to the same profile again restores this record.
Access Control¶
Allowed role: admin, within the brand of the caller.
Request¶
DELETE request
DELETE https://{broker_domain}/sms/agent?id=12
Authorization: <JWT_TOKEN>
{
"command": "SmsDeleteAgent",
"extID": "1",
"data": {
"id": 12
}
}
const res = await platform.SmsDeleteAgent({
id: 12
});
Request Data¶
| Field | Type | Required | Description |
|---|---|---|---|
id |
int | Yes | Link id |
Response Data¶
{
"id": 12,
"deleted": true,
"message": "Agent with ID 12 has been deleted"
}
Errors¶
| Code | Error | Description |
|---|---|---|
404 |
NOT_FOUND |
Link not found in the brand |