Retrieve a list of scopes for which this user has access

The name you will use to describe this API Key

The individual permissions that you are giving to this API Key

Retrieve all API Keys belonging to the authenticated user

Specifies the number of results to be returned by the API

limit

api_key_id

offset

List of offering names to assign to account

accountID

The email address the alert will be sent to

Required for stats_notification. How frequently the alert will be sent.

Required for usage_alert. When this usage threshold is reached the alert will be sent.

The ID of the alert you would like to retrieve.

alert_id

The ID of the alert you would like to retrieve

The new email address you want your alert to be sent to

The new frequency at which to send the stats_notification alert

The new percentage threshold at which the usage_limit alert will be sent.

The start of the time range when a blocked email was created (inclusive)

start_time

The end of the time range when a blocked email was created (inclusive)

end_time

Limit the number of results to be displayed per page

The point in the list to begin displaying results

Specifies which records to return based on the records' associated email addresses

email

Indicates if you want to delete all blocked email addresses

The specific blocked email addresses that you want to delete.

Refers start of the time range in unix timestamp when a bounce was created

Refers end of the time range in unix timestamp when a bounce was created

The point in the list to begin displaying results.

delete_all

Delete multiple emails from your bounce list at the same time.

emails

The email address you would like to remove from the bounce list

The start of the time range in YYYY-MM-DD format when a bounce was created

start_date

The end of the time range in YYYY-MM-DD format when a bounce was created.

end_date

Retrieve bounces by specific classification

The classification you want to filter by.

classification

This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups

The pool of IPs that you would like to send this email from

The segment IDs that you are sending this list to

The ID of the "sender" identity that you have created.
list_ids

The subject of your campaign that your recipients will see

The suppression group that this marketing email belongs to allowing recipients to opt-out of emails of this type

The number of results you would like to receive at a time

The index of the first campaign to return where 0 is the first campaign.

The id of the campaign you would like to retrieve.

campaign_id

The unix timestamp for the date and time you would like your campaign to be sent out.

The email address that should receive the test campaign.

An ID that matches a certificate to a specific IdP integration

This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes

An ID that matches a certificate to a specific IdP integration.

integration_id

cert_id

Indicates whether or not the certificate is enabled

One or more contacts objects that you intend to upsert.

An array of List ID strings that this contact will be added to

Must be set to "true" to delete all contacts

delete_all_contacts

IDs of the contact lists you want to export

IDs of the contact segments you want to export

The ID of the Event Webhook you want to retrieve

Import file header to reserved/custom field mapping.

All contacts will be added to each of the specified lists

The ID of the Event Webhook you want to retrieve.

One or more primary and/or alternate email addresses to search for in your Marketing Campaigns contacts.

The ID of the custom field that you want to retrieve.

custom_field_id

list_id

Adds the ability to delete all contacts on the list in addition to deleting the list.

delete_contacts

The ID of the list whose recipients you are requesting.

page

page_size

The id of the list of recipients you want to retrieve.

The ID of the list that you want to add the recipient to

The ID of the recipient you are adding to the list.

recipient_id

Delete a Single Recipient from a Single List

The ID of the list you are taking this recipient away from

The ID of the recipient to take off the list.

Page index of first recipients to return (must be a positive integer)

Number of recipients to return at a time (must be a positive integer between 1 and 1000)

The ID of the recipient that you want to retrieve.

Retrieve the lists that a recipient is on

The ID of the recipient for whom you are retrieving lists.

Retrieve the count of billable recipients

The conditions by which this segment should be created

The conditions for a recipient to be included in this segment

The list id from which to make this segment

The ID of the segment you want to request.

segment_id

True to delete all contacts matching the segment in addition to deleting the segment

The ID of the segment from which you want to retrieve recipients.

If true plain_content is always generated from html_content

token corresponding to a specific page of results as provided by metadata

page_token

summary

The ID of the Design you want to duplicate

The ID of the pre-built Design you want to duplicate

exclude_subusers

The username associated with an authenticated domain

username

domain

Whether to allow SendGrid to manage your SPF records DKIM keys and DKIM key rotation

Specify whether to use a custom SPF or allow SendGrid to manage your SPF

Whether to use this authenticated domain as the fallback if no authenticated domains match the sender's domain

The IP addresses that will be included in the custom SPF record for this authenticated domain

The subdomain to use for this authenticated domain

domain_id

Indicates whether to generate a custom SPF record for manual security.

Indicates whether this is the default authenticated domain

The domain to find a default authentication.

ID of the domain to which you are adding an IP

Remove an IP from an authenticated domain

List the authenticated domain associated with the given user

Username for the subuser to find associated authenticated domain.

Disassociate a authenticated domain from a given user

Associate a authenticated domain with a given user

ID of the authenticated domain to associate with the subuser

Username to associate with the authenticated domain

Use the query syntax to filter your email activity.

query

The ID of the message you are requesting details for.

msg_id

Uses a SQL like syntax to indicate which messages to include in the CSV

UUID used to locate the download csv request entry in the DB.

download_uuid

The email address that you want to validate

A one-word classifier for where this validation originated

The email address to send the DNS information to

A custom text block to include in the email body sent with the records.

An array containing the IP(s) you want to allow.

Remove one or more IPs from the allow list

An array of the IDs of the IP address that you want to remove from your allow list

The ID of the allowed IP address that you want to retrieve

rule_id

Remove a specific IP from the allowed list

Array of usernames to be assigned a send IP

Whether or not to warmup the IPs being added.

exclude_whitelabels

The number of IPs you want returned at the same time

The offset for the number of IPs that you are requesting

subuser

sort_by_direction

Retrieve all IP pools an IP address belongs to

The IP address you are retrieving the IP pools for

ip_address

Get a List of all IP Addresses on your Account

Specifies which items to be returned by the API

before_key

after_key

Indicates if the IP address is billed and able to send email

is_enabled

Indicates if a parent on the account is able to send email from the IP address

is_parent_assigned

pool

The start_added_at and end_added_at parameters are used to set a time window

start_added_at

The start_added_at and end_added_at parameters are used to set a time window.

end_added_at

Indicates if the IP address is set to automatically warmup

An array of Subuser IDs the IP address will be assigned to.

The ip path parameter specifies an IP address to make the request against.

Indicates if the IP address is billed and able to send email.

GET all IP Pools that have Associated IPs

Create an IP Pool with a Name and IP Assignments

An array of IP addresses to assign to the IP Pool.

poolid

An array of IP addresses to assign to the specified IP Pool.

An array of IP addresses to remove from the specified IP Pool.

Specifies the number of results to be returned by the API.

An array of Subuser IDs to be assigned to the specified IP address.

The name of the IP pool you want to add the address to

pool_name

The IP address that you want to add to the named pool

The name of the IP pool that you want to retrieve the IP addresses for

The name of the IP pool that you are removing the IP address from

The IP address that you want to begin warming up

Retrieve the warmup status for a specific IP address

The IP address that you want to retrieve the warmup status for

Refers start of the time range in unix timestamp when an invalid email was created (inclusive)

Refers end of the time range in unix timestamp when an invalid email was created (inclusive)

Paging offset. The point in the list to begin displaying results

This parameter allows you to filter results by email address.

Indicates if you want to remove all email address from the invalid emails list

The list of specific email addresses that you want to remove.

The specific email address of the invalid email entry that you want to retrieve.

Indicates if you want to remove all email address from the invalid emails list.
emails

Indicates if you want to use this link branding as the default or fallback.

The root domain for the subdomain that you are creating the link branding for

The subdomain to create the link branding for.

Limits the number of results returned per page

The ID of the branded link that you want to validate

The ID of the branded link you want to associate