Skip to contentSkip to navigationSkip to topbar
On this page

Get a specific Sender



API Overview

api-overview page anchor

GET/v3/marketing/senders/{id}

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint allows you to get the details for a specific Sender by id.


Authentication

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

on-behalf-ofstring

Optional

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.

Property nameTypeRequiredDescription
idintegerrequired

The unique identifier of the Sender.

200404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

The unique identifier of the Sender.


nicknamestring

A nickname for the Sender. Not used for sending.


fromobject

reply_toobject

addressstring

The physical address of the Sender.


address_2string

Additional Sender address information.


citystring

The city of the Sender.


statestring

The state of the Sender.


zipstring

The zipcode of the Sender.


countrystring

The country of the Sender.


verifiedboolean

A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email.


lockedboolean

A boolean flag that is true when the Sender is associated with a campaign in Draft, Scheduled, or In Progress status. You cannot update or delete a locked Sender.


updated_atinteger

The time the Sender was last updated.


created_atinteger

The time the Sender was created.

Get a specific Sender by IDLink to code sample: Get a specific Sender by ID
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const id = 1;
5
6
const request = {
7
url: `/v3/marketing/senders/${id}`,
8
method: "GET",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.