MailerDeleteProvider¶
DELETE mailer/provider
Soft-deletes a provider. History keeps referencing it, so old emails still show which provider they went through.
The name stays reserved: creating a provider with the same name later restores this record.
Access Control¶
Allowed role: provider.
Request¶
DELETE request
DELETE https://{broker_domain}/mailer/provider?id=1
Authorization: <JWT_TOKEN>
{
"command": "MailerDeleteProvider",
"extID": "1",
"data": {
"id": 1
}
}
const res = await platform.MailerDeleteProvider({
id: 1
});
Request Data¶
| Field | Type | Required | Description |
|---|---|---|---|
id |
int | Yes | Provider id |
Response Data¶
{
"id": 1,
"deleted": true,
"message": "Provider with ID 1 has been deleted"
}
Errors¶
| Code | Error | Description |
|---|---|---|
404 |
NOT_FOUND |
Provider not found |
409 |
PROVIDER_IN_USE |
Profiles still reference this provider |