Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
Rate this page:
On this page

Delete a Sender

API Overview

api-overview page anchor

Operation overview

operation-overview page anchor

DELETE/v3/marketing/senders/{id}

Base url: https://api.sendgrid.com

This endpoint allows you to delete an existing Sender.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
idintegerrequired

The unique identifier of the Sender.

Responses

responses page anchor
204403404

successfully deleted, no response in payload

Delete a specific Sender

delete-a-specific-sender page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_19
const client = require('@sendgrid/client');
_19
client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19
const id = 1;
_19
_19
const request = {
_19
url: `/v3/marketing/senders/${id}`,
_19
method: 'DELETE',
_19
_19
}
_19
_19
client.request(request)
_19
.then(([response, body]) => {
_19
console.log(response.statusCode);
_19
console.log(response.body);
_19
})
_19
.catch(error => {
_19
console.error(error);
_19
});

Rate this page: