This endpoint allows you to get the details for a specific Sender by id
.
Bearer <<YOUR_API_KEY_HERE>>
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.
The unique identifier of the Sender.
Optional
The unique identifier of the Sender.
Optional
A nickname for the Sender. Not used for sending.
Optional
Optional
Optional
The physical address of the Sender.
Optional
Additional Sender address information.
Optional
The city of the Sender.
Optional
The state of the Sender.
Optional
The zipcode of the Sender.
Optional
The country of the Sender.
Optional
A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email.
Optional
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.
Optional
The time the Sender was last updated.
Optional
The time the Sender was created.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const id = 1;56const request = {7url: `/v3/marketing/senders/${id}`,8method: "GET",9};1011client12.request(request)13.then(([response, body]) => {14console.log(response.statusCode);15console.log(response.body);16})17.catch((error) => {18console.error(error);19});