Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

View a Sender Identity



API Overview

api-overview page anchor
(warning)

Legacy Marketing Campaigns

You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns

(information)

Info

For the most up-to-date information on the Sender Identities API, please visit the new Marketing Campaigns Senders API.

To protect your sending reputation and to uphold legitimate sending behavior, Twilio SendGrid requires customers to verify their Sender Identities.

You can verify one or more Sender Identities using either Domain Authentication or Single Sender Verification.


GET/v3/senders/{sender_id}

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

This endpoint allows you to retrieve a specific sender identity.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

sender_idintegerrequired

The ID of the sender identity that you want to retrieve.

200404
SchemaExample
nicknamestring

A nickname for the sender identity. Not used for sending.


fromobject

reply_toobject

addressstring

The physical address of the sender identity.


address_2string

Additional sender identity address information.


citystring

The city of the sender identity.


statestring

The state of the sender identity.


zipstring

The zipcode of the sender identity.


countrystring

The country of the sender identity.


idinteger

The unique identifier of the sender identity.


verifiedboolean

If the sender identity is verified or not. Only verified sender identities can be used to send email.


updated_atinteger

The time the sender identity was last updated.


created_atinteger

The time the sender identity was created.


lockedboolean

True when the sender id is associated to a campaign in the Draft, Scheduled, or In Progress status. You cannot update or delete a locked sender identity.

View a Sender Identity

view-a-sender-identity 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 sender_id = 4900;
_19
_19
const request = {
_19
url: `/v3/senders/${sender_id}`,
_19
method: 'GET',
_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: