This documentation is based on our Swagger specification.
import sendgrid
import os
sg = sendgrid.SendGridAPIClient(apikey='SENDGRID_API_KEY')
# You can also store your API key an .env variable 'SENDGRID_API_KEY'- API KEY
- API KEYS
- ASM
- BROWSERS
- CAMPAIGNS
- CATEGORIES
- CLIENTS
- CONTACTDB
- DEVICES
- GEO
- IPS
- MAIL SETTINGS
- MAILBOX PROVIDERS
- PARTNER SETTINGS
- SCOPES
- STATS
- SUBUSERS
- SUPPRESSION
- TEMPLATES
- TRACKING SETTINGS
- USER
- WHITELABEL
This will create a new random API Key for the user. A JSON request body containing a "name" property is required. If number of maximum keys is reached, HTTP 403 will be returned.
There is a limit of 100 API Keys on your account.
The API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the Mail API Endpoint.
See the API Key Permissions List for a list of all available scopes.
data = {'sample': 'data'}
response = self.sg.client.api_key.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
The API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the Mail API Endpoint.
response = self.sg.client.api_keys.get()
print response.status_code
print response.response_body
print response.response_headers
A JSON request body with a "name" property is required. Most provide the list of all the scopes an api key should have.
The API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the Mail API Endpoint.
data = {'sample': 'data'}
api_key_id = "test_url_param"
response = self.sg.client.api_keys._(api_key_id).put(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Update the name of an existing API Key
A JSON request body with a "name" property is required.
The API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the Mail API Endpoint.
| URI Parameter | Type | Required? | Description |
|---|---|---|---|
| api_key_id | string | required | The ID of the API Key you are updating. |
data = {'sample': 'data'}
api_key_id = "test_url_param"
response = self.sg.client.api_keys._(api_key_id).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Retrieve a single api key. If the API Key ID does not exist an HTTP 404 will be returned.
| Param | Type | Required? | Description |
|---|---|---|---|
| api_key_id | string | required | The ID of the API Key for which you are requesting information. |
api_key_id = "test_url_param"
response = self.sg.client.api_keys._(api_key_id).get()
print response.status_code
print response.response_body
print response.response_headers
Revoke an existing API Key
Authentications using this API Key will fail after this request is made, with some small propogation delay.If the API Key ID does not exist an HTTP 404 will be returned.
The API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the Mail API Endpoint.
| URI Parameter | Type | Required? | Description |
|---|---|---|---|
| api_key_id | string | required | The ID of the API Key you are deleting. |
api_key_id = "test_url_param"
response = self.sg.client.api_keys._(api_key_id).delete()
print response.status_code
print response.response_body
print response.response_headers
This endoint allows you to create a new suppression group.
Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
The name and description of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
Each user can create up to 25 different suppression groups.
data = {'sample': 'data'}
response = self.sg.client.asm.groups.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a list of all suppression groups created by this user.
Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
The name and description of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
Each user can create up to 25 different suppression groups.
response = self.sg.client.asm.groups.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update or change a suppression group.
Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
The name and description of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
Each user can create up to 25 different suppression groups.
data = {'sample': 'data'}
group_id = "test_url_param"
response = self.sg.client.asm.groups._(group_id).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a single suppression group.
Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
The name and description of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
Each user can create up to 25 different suppression groups.
group_id = "test_url_param"
response = self.sg.client.asm.groups._(group_id).get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to delete a suppression group.
You can only delete groups that have not been attached to sent mail in the last 60 days. If a recipient uses the "one-click unsubscribe" option on an email associated with a deleted group, that recipient will be added to the global suppression list.
Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
The name and description of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
Each user can create up to 25 different suppression groups.
group_id = "test_url_param"
response = self.sg.client.asm.groups._(group_id).delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to add email addresses to an unsubscribe group.
If you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.
Suppressions are recipient email addresses that are added to unsubscribe groups. Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.
data = {'sample': 'data'}
group_id = "test_url_param"
response = self.sg.client.asm.groups._(group_id).suppressions.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.
Suppressions are recipient email addresses that are added to unsubscribe groups. Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.
group_id = "test_url_param"
response = self.sg.client.asm.groups._(group_id).suppressions.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to remove a suppressed email address from the given suppression group.
Suppressions are recipient email addresses that are added to unsubscribe groups. Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.
group_id = "test_url_param"
email = "test_url_param"
response = self.sg.client.asm.groups._(group_id).suppressions._(email).delete()
print response.status_code
print response.response_body
print response.response_headers
Global Suppressions are email addresses that will not receive any emails.
data = {'sample': 'data'}
response = self.sg.client.asm.suppressions._("global").post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Global Suppressions are email addresses that will not receive any emails.
email_address = "test_url_param"
response = self.sg.client.asm.suppressions._("global")._(email_address).get()
print response.status_code
print response.response_body
print response.response_headers
email = "test_url_param"
response = self.sg.client.asm.suppressions._("global")._(email).get()
print response.status_code
print response.response_body
print response.response_headers
email = "test_url_param"
response = self.sg.client.asm.suppressions._("global")._(email).delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your email statistics segmented by browser type.
We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.
Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our User Guide.
params = {'end_date': 'test_string', 'aggregated_by': 'test_string', 'browsers': 'test_string', 'limit': 'test_string', 'offset': 'test_string', 'start_date': 'test_string'}
response = self.sg.client.browsers.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Our Marketing Campaigns API lets you create, manage, send, and schedule campaigns.
Note: In order to send or schedule the campaign, you will be required to provide a subject, sender ID, content (we suggest both html and plain text), and at least one list or segment ID. This information is not required when you create a campaign.
For more information:
data = {'sample': 'data'}
response = self.sg.client.campaigns.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Returns campaigns in reverse order they were created (newest first).
Returns an empty array if no campaigns exist.
For more information:
params = {'limit': 0, 'offset': 0}
response = self.sg.client.campaigns.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Update a campaign. This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many of the parameters.
For more information:
data = {'sample': 'data'}
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This is a place for notes and extra information about this endpoint. It is written in Markdown - more info in the documentation.
There are several special markdown helpers that automatically build tables and html off of your endpoint definition. You can find some examples in this content.
Click the "Open Editor" button above to start editing this content.
For more information:
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).get()
print response.status_code
print response.response_body
print response.response_headers
For more information:
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).delete()
print response.status_code
print response.response_body
print response.response_headers
Changes the send_at time for the specified campaign.
For more information:
data = {'sample': 'data'}
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).schedules.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Send your campaign at a specific date and time.
For more information:
data = {'sample': 'data'}
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).schedules.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
View the time that this campaign is scheduled to be sent.
For more information:
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).schedules.get()
print response.status_code
print response.response_body
print response.response_headers
A successful unschedule will return a 204. If the specified campaign is in the process of being sent, the only option is to cancel (a different method).
For more information:
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).schedules.delete()
print response.status_code
print response.response_body
print response.response_headers
Send your campaign right now. Normally a POST would have a request body, but since this endpoint is telling us to send a resource that is already created, we don't need a body.
For more information:
data = {'sample': 'data'}
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).schedules.now.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
To send to multiple addresses, use an array for the JSON "to" value ["one@address","two@address"]
For more information:
data = {'sample': 'data'}
campaign_id = "test_url_param"
response = self.sg.client.campaigns._(campaign_id).schedules.test.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
params = {'category': 'test_string', 'sort_by': 'test_string', 'limit': 0, 'order': 'test_string', 'offset': 0}
response = self.sg.client.categories.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve all of your email statistics for each of your categories.
If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
Categories allow you to group your emails together according to broad topics that you define. For more information, please see our User Guide.
params = {'end_date': 'test_string', 'aggregated_by': 'test_string', 'limit': 0, 'offset': 0, 'start_date': 'test_string', 'categories': 'test_string'}
response = self.sg.client.categories.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.
If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
Categories allow you to group your emails together according to broad topics that you define. For more information, please see our User Guide.
params = {'end_date': 'test_string', 'aggregated_by': 'test_string', 'limit': 0, 'sort_by_metric': 'test_string', 'offset': 0, 'start_date': 'test_string', 'sort_by_direction': 'test_string'}
response = self.sg.client.categories.stats.sums.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your email statistics segmented by client type.
We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.
Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our User Guide.
params = {'aggregated_by': 'test_string', 'start_date': 'test_string', 'end_date': 'test_string'}
response = self.sg.client.clients.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your email statistics segmented by a specific client type.
We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.
- phone
- tablet
- webmail
- desktop
Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our User Guide.
params = {'aggregated_by': 'test_string', 'start_date': 'test_string', 'end_date': 'test_string'}
client_type = "test_url_param"
response = self.sg.client.clients._(client_type).stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Create a custom field.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
response = self.sg.client.contactdb.custom_fields.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Get all custom fields.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
response = self.sg.client.contactdb.custom_fields.get()
print response.status_code
print response.response_body
print response.response_headers
Get a custom field by ID.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'custom_field_id': 0}
custom_field_id = "test_url_param"
response = self.sg.client.contactdb.custom_fields._(custom_field_id).get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Delete a custom field by ID.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
custom_field_id = "test_url_param"
response = self.sg.client.contactdb.custom_fields._(custom_field_id).delete()
print response.status_code
print response.response_body
print response.response_headers
Create a list for your recipients.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
response = self.sg.client.contactdb.lists.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Returns an empty list if you GET and no lists exist on your account.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
response = self.sg.client.contactdb.lists.get()
print response.status_code
print response.response_body
print response.response_headers
Delete multiple lists.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
response = self.sg.client.contactdb.lists.delete()
print response.status_code
print response.response_body
print response.response_headers
Update the name of a list.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
params = {'list_id': 0}
list_id = "test_url_param"
response = self.sg.client.contactdb.lists._(list_id).patch(request_body=data, query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Get a single list.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'list_id': 0}
list_id = "test_url_param"
response = self.sg.client.contactdb.lists._(list_id).get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Delete a list by ID.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'delete_contacts': 0}
list_id = "test_url_param"
response = self.sg.client.contactdb.lists._(list_id).delete(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs should be passed exactly as they are returned from recipient endpoints.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
params = {'list_id': 0}
list_id = "test_url_param"
response = self.sg.client.contactdb.lists._(list_id).recipients.post(request_body=data, query_params=params)
print response.status_code
print response.response_body
print response.response_headers
List all the recipients currently on a specific list.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'page': 0, 'page_size': 0, 'list_id': 0}
list_id = "test_url_param"
response = self.sg.client.contactdb.lists._(list_id).recipients.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Add a recipient to a list.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
params = {'recipient_id': 'test_string', 'list_id': 0}
list_id = "test_url_param"
recipient_id = "test_url_param"
response = self.sg.client.contactdb.lists._(list_id).recipients._(recipient_id).post(request_body=data, query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Delete a single recipient from a list.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'recipient_id': 0, 'list_id': 0}
list_id = "test_url_param"
recipient_id = "test_url_param"
response = self.sg.client.contactdb.lists._(list_id).recipients._(recipient_id).delete(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Updates one or more recipients. The body is an array of recipient objects.
It is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields SendGrid provides.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
response = self.sg.client.contactdb.recipients.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Add a recipient to your contactdb. It is of note that you can add custom field data as a parameter on this endpoint. We have provided an example using some of the default custom fields SendGrid provides.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
response = self.sg.client.contactdb.recipients.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Batch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of the list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'page': 0, 'page_size': 0}
response = self.sg.client.contactdb.recipients.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Deletes one or more recipients. The body is a list of recipient ids to delete.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
response = self.sg.client.contactdb.recipients.delete()
print response.status_code
print response.response_body
print response.response_headers
You are billed for marketing campaigns based on the highest number of recipients you have had in your account at one time. This endpoint will allow you to know the current billable count value.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
response = self.sg.client.contactdb.recipients.billable_count.get()
print response.status_code
print response.response_body
print response.response_headers
Get a count of the current number of recipients in your contact database.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
response = self.sg.client.contactdb.recipients.count.get()
print response.status_code
print response.response_body
print response.response_headers
Search the recipients in your contactdb.
field_name:
- is a variable that is substituted for your actual custom field name from your recipient.
- Text fields must be url-encoded. Date fields are searchable only by unix timestamp (e.g. 2/2/2015 becomes 1422835200)
- If field_name is a 'reserved' date field, such as created_at or updated_at, the system will internally convert your epoch time to a date range encompassing the entire day. For example, an epoch time of 1422835600 converts to Mon, 02 Feb 2015 00:06:40 GMT, but internally the system will search from Mon, 02 Feb 2015 00:00:00 GMT through Mon, 02 Feb 2015 23:59:59 GMT.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'{field_name}': 'test_string'}
response = self.sg.client.contactdb.recipients.search.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Retrieve a single recipient by ID from your contact database.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'recipient_id': 'test_string'}
recipient_id = "test_url_param"
response = self.sg.client.contactdb.recipients._(recipient_id).get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Delete a single recipient from your contact database, by ID.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'recipient_id': 'test_string'}
recipient_id = "test_url_param"
response = self.sg.client.contactdb.recipients._(recipient_id).delete(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Each recipient can be on many lists. This endpoint gives you the lists this recipient is associated to.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'recipient_id': 'test_string'}
recipient_id = "test_url_param"
response = self.sg.client.contactdb.recipients._(recipient_id).lists.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
List fields that are reserved and can't be used for custom field names. [GET]
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
response = self.sg.client.contactdb.reserved_fields.get()
print response.status_code
print response.response_body
print response.response_headers
Create a segment. All recipients in your contactdb will be added or removed automatically depending on whether they match the criteria for this segment.
List Id:
- Send this to segment from an existing list
- Don't send this in order to segment from your entire contactdb.
Valid operators for create and update depend on the type of the field you are segmenting:
- Dates: "eq", "ne", "lt" (before), "gt" (after)
- Text: "contains", "eq" (is - matches the full field), "ne" (is not - matches any field where the entire field is not the condition value)
- Numbers: "eq", "lt", "gt"
- Email Clicks and Opens: "eq" (opened), "ne" (not opened)
Segment conditions using "eq" or "ne" for email clicks and opens should provide a "field" of either clicks.campaign_identifier or opens.campaign_identifier. The condition value should be a string containing the id of a completed campaign.
Segments may contain multiple condtions, joined by an "and" or "or" in the "and_or" field. The first condition in the conditions list must have an empty "and_or", and subsequent conditions must all specify an "and_or".
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
response = self.sg.client.contactdb.segments.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Get all your segments.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
response = self.sg.client.contactdb.segments.get()
print response.status_code
print response.response_body
print response.response_headers
Update a segment.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
data = {'sample': 'data'}
params = {'segment_id': 'test_string'}
segment_id = "test_url_param"
response = self.sg.client.contactdb.segments._(segment_id).patch(request_body=data, query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Get a single segment by ID.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'segment_id': 0}
segment_id = "test_url_param"
response = self.sg.client.contactdb.segments._(segment_id).get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Delete a segment from your contactdb. You also have the option to delete all the contacts from your contactdb who were in this segment.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'delete_contacts': 0}
segment_id = "test_url_param"
response = self.sg.client.contactdb.segments._(segment_id).delete(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
List all of the recipients in a segment.
The contactdb is a database of your contacts for SendGrid Marketing Campaigns.
params = {'page': 0, 'page_size': 0}
segment_id = "test_url_param"
response = self.sg.client.contactdb.segments._(segment_id).recipients.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your email statistics segmented by the device type.
We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.
| Device | Description | Example |
|---|---|---|
| Desktop | Email software on desktop computer. | I.E., Outlook, Sparrow, or Apple Mail. |
| Webmail | A web-based email client. | I.E., Yahoo, Google, AOL, or Outlook.com. |
| Phone | A smart phone. | iPhone, Android, Blackberry, etc. |
| Tablet | A tablet computer. | iPad, android based tablet, etc. |
| Other | An unrecognized device. |
Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our User Guide.
params = {'aggregated_by': 'test_string', 'limit': 0, 'start_date': 'test_string', 'end_date': 'test_string', 'offset': 0}
response = self.sg.client.devices.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your email statistics segmented by country and state/province.
We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.
Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our User Guide.
params = {'end_date': 'test_string', 'country': 'test_string', 'aggregated_by': 'test_string', 'limit': 0, 'offset': 0, 'start_date': 'test_string'}
response = self.sg.client.geo.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
See a list of all assigned and unassigned IPs. Response includes warm up status, pools, assigned subusers, and whitelabel info. The start_date field corresponds to when warmup started for that IP.
params = {'subuser': 'test_string', 'ip': 'test_string', 'limit': 0, 'exclude_whitelabels': 0, 'offset': 0}
response = self.sg.client.ips.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Retrieve a list of your IP addresses.
response = self.sg.client.ips.assigned.get()
print response.status_code
print response.response_body
print response.response_headers
data = {'sample': 'data'}
response = self.sg.client.ips.pools.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
response = self.sg.client.ips.pools.get()
print response.status_code
print response.response_body
print response.response_headers
data = {'sample': 'data'}
pool_name = "test_url_param"
response = self.sg.client.ips.pools._(pool_name).put(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
pool_name = "test_url_param"
response = self.sg.client.ips.pools._(pool_name).get()
print response.status_code
print response.response_body
print response.response_headers
pool_name = "test_url_param"
response = self.sg.client.ips.pools._(pool_name).delete()
print response.status_code
print response.response_body
print response.response_headers
data = {'sample': 'data'}
pool_name = "test_url_param"
response = self.sg.client.ips.pools._(pool_name).ips.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
pool_name = "test_url_param"
ip = "test_url_param"
response = self.sg.client.ips.pools._(pool_name).ips._(ip).delete()
print response.status_code
print response.response_body
print response.response_headers
data = {'sample': 'data'}
response = self.sg.client.ips.warmup.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
response = self.sg.client.ips.warmup.get()
print response.status_code
print response.response_body
print response.response_headers
ip_address = "test_url_param"
response = self.sg.client.ips.warmup._(ip_address).get()
print response.status_code
print response.response_body
print response.response_headers
ip_address = "test_url_param"
response = self.sg.client.ips.warmup._(ip_address).delete()
print response.status_code
print response.response_body
print response.response_headers
ip_address = "test_url_param"
response = self.sg.client.ips._(ip_address).get()
print response.status_code
print response.response_body
print response.response_headers
Generate a new Batch ID to associate with scheduled sends via the mail/send endpoint.
If you set the SMTPAPI header batch_id, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
More Information:
data = {'sample': 'data'}
response = self.sg.client.mail.batch.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Validate whether or not a batch id is valid.
If you set the SMTPAPI header batch_id, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
More Information:
batch_id = "test_url_param"
response = self.sg.client.mail.batch._(batch_id).get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a list of all mail settings.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
params = {'limit': 0, 'offset': 0}
response = self.sg.client.mail_settings.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current email address whitelist settings.
The address whitelist setting whitelists a specified email address or domain for which mail should never be suppressed. For example, you own the domain example.com, and one or more of your recipients use [email protected] addresses, by placing example.com in the address whitelist setting, all bounces, blocks, and unsubscribes logged for that domain will be ignored and sent as if under normal sending conditions.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.address_whitelist.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current email address whitelist settings.
The address whitelist setting whitelists a specified email address or domain for which mail should never be suppressed. For example, you own the domain example.com, and one or more of your recipients use [email protected] addresses, by placing example.com in the address whitelist setting, all bounces, blocks, and unsubscribes logged for that domain will be ignored and sent as if under normal sending conditions.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.address_whitelist.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current BCC mail settings.
When the BCC mail setting is enabled, SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field, if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.bcc.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current BCC mail settings.
When the BCC mail setting is enabled, SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field, if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.bcc.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current bounce purge settings.
This setting allows you to set a schedule for SendGrid to automatically delete contacts from your soft and hard bounce suppression lists.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.bounce_purge.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current bounce purge settings.
This setting allows you to set a schedule for SendGrid to automatically delete contacts from your soft and hard bounce suppression lists.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.bounce_purge.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current Footer mail settings.
The footer setting will insert a custom footer at the bottom of the text and HTML bodies. Use the embedded HTML editor and plain text entry fields to create the content of the footers to be inserted into your emails.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.footer.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current Footer mail settings.
The footer setting will insert a custom footer at the bottom of the text and HTML bodies. Use the embedded HTML editor and plain text entry fields to create the content of the footers to be inserted into your emails.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.footer.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current bounce forwarding mail settings.
Activating this setting allows you to specify an email address to which bounce reports are forwarded.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.forward_bounce.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current bounce forwarding mail settings.
Activating this setting allows you to specify an email address to which bounce reports are forwarded.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.forward_bounce.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current Forward Spam mail settings.
Enabling the forward spam setting allows you to specify an email address to which spam reports will be forwarded.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.forward_spam.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current Forward Spam mail settings.
Enabling the forward spam setting allows you to specify an email address to which spam reports will be forwarded.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.forward_spam.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current Plain Content mail settings.
The plain content setting will automatically convert any plain text emails that you send to HTML before sending.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.plain_content.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current Plain Content mail settings.
The plain content setting will automatically convert any plain text emails that you send to HTML before sending.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.plain_content.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current spam checker mail settings.
The spam checker filter notifies you when emails are detected that exceed a predefined spam threshold.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.spam_check.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current Spam Checker mail settings.
The spam checker filter notifies you when emails are detected that exceed a predefined spam threshold.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.spam_check.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current legacy email template settings.
This setting refers to our original email templates. We currently support more fully featured transactional templates.
The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
data = {'sample': 'data'}
response = self.sg.client.mail_settings.template.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current legacy email template settings.
This setting refers to our original email templates. We currently support more fully featured transactional templates.
The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages.
Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrids Web API or SMTP Relay.
response = self.sg.client.mail_settings.template.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.
We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.
Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our User Guide.
params = {'end_date': 'test_string', 'mailbox_providers': 'test_string', 'aggregated_by': 'test_string', 'limit': 0, 'offset': 0, 'start_date': 'test_string'}
response = self.sg.client.mailbox_providers.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a list of all partner settings that you can enable.
Our partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating with them, please visit our User Guide.
params = {'limit': 0, 'offset': 0}
response = self.sg.client.partner_settings.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update or change your New Relic partner settings.
Our partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating with them, please visit our User Guide.
By integrating with New Relic, you can send your SendGrid email statistics to your New Relic Dashboard. If you enable this setting, your stats will be sent to New Relic every 5 minutes. You will need your New Relic License Key to enable this setting. For more information, please see our Classroom.
data = {'sample': 'data'}
response = self.sg.client.partner_settings.new_relic.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current New Relic partner settings.
Our partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating with them, please visit our User Guide.
By integrating with New Relic, you can send your SendGrid email statistics to your New Relic Dashboard. If you enable this setting, your stats will be sent to New Relic every 5 minutes. You will need your New Relic License Key to enable this setting. For more information, please see our Classroom.
response = self.sg.client.partner_settings.new_relic.get()
print response.status_code
print response.response_body
print response.response_headers
data = {'sample': 'data'}
response = self.sg.client.partner_settings.sendwithus.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
response = self.sg.client.partner_settings.sendwithus.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint returns a list of all scopes that this user has access to.
API Keys can be used to authenticate the use of SendGrids v3 Web API, or the Mail API Endpoint. API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissios, please visit our User Guide or Classroom.
response = self.sg.client.scopes.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve all of your global email statistics between a given date range.
Parent accounts will see aggregated stats for their account and all subuser accounts. Subuser accounts will only see their own stats.
params = {'aggregated_by': 'test_string', 'limit': 0, 'start_date': 'test_string', 'end_date': 'test_string', 'offset': 0}
response = self.sg.client.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a list of all of your subusers. You can choose to retrieve specific subusers as well as limit the results that come back from the API.
For more information about Subusers:
data = {'sample': 'data'}
response = self.sg.client.subusers.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a list of all of your subusers. You can choose to retrieve specific subusers as well as limit the results that come back from the API.
For more information about Subusers:
params = {'username': 'test_string', 'limit': 0, 'offset': 0}
response = self.sg.client.subusers.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will effect your sender rating.
This endpoint allows you to request the reputations for your subusers.
params = {'usernames': 'test_string'}
response = self.sg.client.subusers.reputations.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve the email statistics for the given subusers.
You may retrieve statistics for up to 10 different subusers by including an additional subusers parameter for each additional subuser.
While you can always view the statistics for all email activity on your account, subuser statistics enable you to view specific segments of your stats. Emails sent, bounces, and spam reports are always tracked for subusers. Unsubscribes, clicks, and opens are tracked if you have enabled the required settings.
For more information, see our User Guide.
params = {'end_date': 'test_string', 'aggregated_by': 'test_string', 'limit': 0, 'offset': 0, 'start_date': 'test_string', 'subusers': 'test_string'}
response = self.sg.client.subusers.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.
While you can always view the statistics for all email activity on your account, subuser statistics enable you to view specific segments of your stats. Emails sent, bounces, and spam reports are always tracked for subusers. Unsubscribes, clicks, and opens are tracked if you have enabled the required settings.
For more information, see our User Guide.
params = {'end_date': 'test_string', 'aggregated_by': 'test_string', 'limit': 0, 'sort_by_metric': 'test_string', 'offset': 0, 'start_date': 'test_string', 'sort_by_direction': 'test_string'}
response = self.sg.client.subusers.stats.sums.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to enable or disable a subuser.
For more information about Subusers:
data = {'sample': 'data'}
subuser_name = "test_url_param"
response = self.sg.client.subusers._(subuser_name).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to delete a subuser. This is a permanent action, once deleted a subuser cannot be retrieved.
For more information about Subusers:
subuser_name = "test_url_param"
response = self.sg.client.subusers._(subuser_name).delete()
print response.status_code
print response.response_body
print response.response_headers
Each subuser should be assigned to an IP address, from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have their own, or multiple, IP addresses as well.
More information:
data = {'sample': 'data'}
subuser_name = "test_url_param"
response = self.sg.client.subusers._(subuser_name).ips.put(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Subuser monitor settings allow you to receive a sample of an outgoing message by a specific customer at a specific frequency of emails.
data = {'sample': 'data'}
subuser_name = "test_url_param"
response = self.sg.client.subusers._(subuser_name).monitor.put(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Subuser monitor settings allow you to receive a sample of an outgoing message by a specific customer at a specific frequency of emails.
data = {'sample': 'data'}
subuser_name = "test_url_param"
response = self.sg.client.subusers._(subuser_name).monitor.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Subuser monitor settings allow you to receive a sample of an outgoing message by a specific customer at a specific frequency of emails.
subuser_name = "test_url_param"
response = self.sg.client.subusers._(subuser_name).monitor.get()
print response.status_code
print response.response_body
print response.response_headers
Subuser monitor settings allow you to receive a sample of an outgoing message by a specific customer at a specific frequency of emails.
subuser_name = "test_url_param"
response = self.sg.client.subusers._(subuser_name).monitor.delete()
print response.status_code
print response.response_body
print response.response_headers
Bounces are messages that are returned to the server that sent it.
For more information see:
- User Guide > Bounces for more information
- Glossary > Bounces
params = {'start_time': 0, 'end_time': 0}
response = self.sg.client.suppression.bounces.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
Bounces are messages that are returned to the server that sent it. This endpoint allows you to delete email addresses from your bounce list.
For more information see:
- User Guide > Bounces for more information
- Glossary > Bounces
- Classroom > List Scrubbing Guide
Note: the 'delete_all' and 'emails' parameters should be used independently of each other as they have different purposes.
response = self.sg.client.suppression.bounces.delete()
print response.status_code
print response.response_body
print response.response_headers
email = "test_url_param"
response = self.sg.client.suppression.bounces._(email).get()
print response.status_code
print response.response_body
print response.response_headers
Bounces are messages that are returned to the server that sent it. This endpoint allows you to delete a single email addresses from your bounce list.
For more information see:
- User Guide > Bounces for more information
- Glossary > Bounces
- Classroom > List Scrubbing Guide
params = {'email_address': 'test_string'}
email = "test_url_param"
response = self.sg.client.suppression.bounces._(email).delete(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to create a transactional template.
Each user can create up to 300 different transactional templates. Transactional templates are specific to accounts and subusers. Templates created on a parent account will not be accessible from the subuser accounts.
Transactional templates are templates created specifically for transactional email and are not to be confused with Marketing Campaigns templates. For more information about transactional templates, please see our User Guide.
data = {'sample': 'data'}
response = self.sg.client.templates.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve all transactional templates.
Each user can create up to 300 different transactional templates. Transactional templates are specific to accounts and subusers. Templates created on a parent account will not be accessible from the subuser accounts.
Transactional templates are templates created specifically for transactional email and are not to be confused with Marketing Campaigns templates. For more information about transactional templates, please see our User Guide.
response = self.sg.client.templates.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to edit a transactional template.
Each user can create up to 300 different transactional templates. Transactional templates are specific to accounts and subusers. Templates created on a parent account will not be accessible from the subuser accounts.
Transactional templates are templates created specifically for transactional email and are not to be confused with Marketing Campaigns templates. For more information about transactional templates, please see our User Guide.
data = {'sample': 'data'}
template_id = "test_url_param"
response = self.sg.client.templates._(template_id).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a single transactional template.
Each user can create up to 300 different transactional templates. Transactional templates are specific to accounts and subusers. Templates created on a parent account will not be accessible from the subuser accounts.
Transactional templates are templates created specifically for transactional email and are not to be confused with Marketing Campaigns templates. For more information about transactional templates, please see our User Guide.
template_id = "test_url_param"
response = self.sg.client.templates._(template_id).get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to delete a transactional template.
Each user can create up to 300 different transactional templates. Transactional templates are specific to accounts and subusers. Templates created on a parent account will not be accessible from the subuser accounts.
Transactional templates are templates created specifically for transactional email and are not to be confused with Marketing Campaigns templates. For more information about transactional templates, please see our User Guide.
template_id = "test_url_param"
response = self.sg.client.templates._(template_id).delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to create a new version of a template.
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
For more information about transactional templates, please see our User Guide.
data = {'sample': 'data'}
template_id = "test_url_param"
response = self.sg.client.templates._(template_id).versions.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to edit a version of one of your transactional templates.
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
For more information about transactional templates, please see our User Guide.
| URI Parameter | Type | Description |
|---|---|---|
| template_id | string | The ID of the original template |
| version_id | string | The ID of the template version |
data = {'sample': 'data'}
template_id = "test_url_param"
version_id = "test_url_param"
response = self.sg.client.templates._(template_id).versions._(version_id).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a specific version of a template.
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
For more information about transactional templates, please see our User Guide.
| URI Parameter | Type | Description |
|---|---|---|
| template_id | string | The ID of the original template |
| version_id | string | The ID of the template version |
template_id = "test_url_param"
version_id = "test_url_param"
response = self.sg.client.templates._(template_id).versions._(version_id).get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to delete one of your transactional template versions.
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
For more information about transactional templates, please see our User Guide.
| URI Parameter | Type | Description |
|---|---|---|
| template_id | string | The ID of the original template |
| version_id | string | The ID of the template version |
template_id = "test_url_param"
version_id = "test_url_param"
response = self.sg.client.templates._(template_id).versions._(version_id).delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to activate a version of one of your templates.
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
For more information about transactional templates, please see our User Guide.
| URI Parameter | Type | Description |
|---|---|---|
| template_id | string | The ID of the original template |
| version_id | string | The ID of the template version |
data = {'sample': 'data'}
template_id = "test_url_param"
version_id = "test_url_param"
response = self.sg.client.templates._(template_id).versions._(version_id).activate.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a list of all tracking settings that you can enable on your account.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
params = {'limit': 0, 'offset': 0}
response = self.sg.client.tracking_settings.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to change your current click tracking setting. You can enable, or disable, click tracking using this endpoint.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
data = {'sample': 'data'}
response = self.sg.client.tracking_settings.click.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current click tracking setting.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
response = self.sg.client.tracking_settings.click.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current setting for Google Analytics.
For more information about using Google Analytics, please refer to Googles URL Builder and their article on "Best Practices for Campaign Building".
We default the settings to Googles recommendations. For more information, see Google Analytics Demystified.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
data = {'sample': 'data'}
response = self.sg.client.tracking_settings.google_analytics.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current setting for Google Analytics.
For more information about using Google Analytics, please refer to Googles URL Builder and their article on "Best Practices for Campaign Building".
We default the settings to Googles recommendations. For more information, see Google Analytics Demystified.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
response = self.sg.client.tracking_settings.google_analytics.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current settings for open tracking.
Open Tracking adds an invisible image at the end of the email which can track email opens. If the email recipient has images enabled on their email client, a request to SendGrids server for the invisible image is executed and an open event is logged. These events are logged in the Statistics portal, Email Activity interface, and are reported by the Event Webhook.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
data = {'sample': 'data'}
response = self.sg.client.tracking_settings.open.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current settings for open tracking.
Open Tracking adds an invisible image at the end of the email which can track email opens. If the email recipient has images enabled on their email client, a request to SendGrids server for the invisible image is executed and an open event is logged. These events are logged in the Statistics portal, Email Activity interface, and are reported by the Event Webhook.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
response = self.sg.client.tracking_settings.open.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update your current settings for subscription tracking.
Subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
data = {'sample': 'data'}
response = self.sg.client.tracking_settings.subscription.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve your current settings for subscription tracking.
Subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.
You can track a variety of the actions your recipients may take when interacting with your emails including opening your emails, clicking on links in your emails, and subscribing to (or unsubscribing from) your emails.
For more information about tracking, please see our User Guide.
response = self.sg.client.tracking_settings.subscription.get()
print response.status_code
print response.response_body
print response.response_headers
Your user's account information includes the user's account type and reputation.
response = self.sg.client.user.account.get()
print response.status_code
print response.response_body
print response.response_headers
Keeping your user profile up to date is important. This will help SendGrid to verify who you are as well as contact you should we need to.
For more information about your user profile:
It should be noted that any one or more of the parameters can be updated via the PATCH /user/profile endpoint. The only requirement is that you include at least one when you PATCH.
data = {'sample': 'data'}
response = self.sg.client.user.profile.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Keeping your user profile up to date is important. This will help SendGrid to verify who you are as well as contact you should we need to.
For more information about your user profile:
response = self.sg.client.user.profile.get()
print response.status_code
print response.response_body
print response.response_headers
Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will be returned.
The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
data = {'sample': 'data'}
response = self.sg.client.user.scheduled_sends.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Get all cancel/paused scheduled send information.
The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
response = self.sg.client.user.scheduled_sends.get()
print response.status_code
print response.response_body
print response.response_headers
Update the status of a scheduled send.
The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
data = {'sample': 'data'}
batch_id = "test_url_param"
response = self.sg.client.user.scheduled_sends._(batch_id).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
Get cancel/paused scheduled send information for a specific batch_id.
The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
batch_id = "test_url_param"
response = self.sg.client.user.scheduled_sends._(batch_id).get()
print response.status_code
print response.response_body
print response.response_headers
Delete the cancellation/pause of a scheduled send.
The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
batch_id = "test_url_param"
response = self.sg.client.user.scheduled_sends._(batch_id).delete()
print response.status_code
print response.response_body
print response.response_headers
data = {'sample': 'data'}
response = self.sg.client.user.settings.enforced_tls.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
response = self.sg.client.user.settings.enforced_tls.get()
print response.status_code
print response.response_body
print response.response_headers
data = {'sample': 'data'}
response = self.sg.client.user.webhooks.event.settings.patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
response = self.sg.client.user.webhooks.event.settings.get()
print response.status_code
print response.response_body
print response.response_headers
data = {'sample': 'data'}
response = self.sg.client.user.webhooks.event.test.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
response = self.sg.client.user.webhooks.parse.settings.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve the statistics for your Parse Webhook useage.
SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incomming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 20MB in size, including all attachments.
There are a number of pre-made integrations for the SendGrid Parse Webhook which make processing events easy. You can find these integrations in the Library Index.
params = {'aggregated_by': 'test_string', 'limit': 'test_string', 'start_date': 'test_string', 'end_date': 'test_string', 'offset': 'test_string'}
response = self.sg.client.user.webhooks.parse.stats.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to create a whitelabel for one of your domains.
If you are creating a domain whitelabel that you would like a subuser to use, you have two options:
- Use the "username" parameter. This allows you to create a whitelabel on behalf of your subuser. This means the subuser is able to see and modify the created whitelabel.
- Use the Association workflow (see Associate Domain section). This allows you to assign a whitelabel created by the parent to a subuser. This means the subuser will default to the assigned whitelabel, but will not be able to see or modify that whitelabel. However, if the subuser creates their own whitelabel it will overwrite the assigned whitelabel.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
data = {'sample': 'data'}
response = self.sg.client.whitelabel.domains.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a list of all domain whitelabels you have created.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
params = {'username': 'test_string', 'domain': 'test_string', 'exclude_subusers': 0, 'limit': 0, 'offset': 0}
response = self.sg.client.whitelabel.domains.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve the default whitelabel for a domain.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
| URI Parameter | Type | Description |
|---|---|---|
| domain | string | The domain to find a default domain whitelabel for. |
response = self.sg.client.whitelabel.domains.default.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve all of the whitelabels that have been assigned to a specific subuser.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
Domain whitelabels can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's whitelabels. To associate a whitelabel with a subuser, the parent account must first create the whitelabel and validate it. The the parent may then associate the whitelabel via the subuser management tools.
For more information on whitelabeling, please see our User Guide
| URI Parameter | Type | Description |
|---|---|---|
| username | string | Username of the subuser to find associated whitelabels for. |
response = self.sg.client.whitelabel.domains.subuser.get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to disassociate a specific whitelabel from a subuser.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
Domain whitelabels can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's whitelabels. To associate a whitelabel with a subuser, the parent account must first create the whitelabel and validate it. The the parent may then associate the whitelabel via the subuser management tools.
For more information on whitelabeling, please see our User Guide
| URI Parameter | Type | Required? | Description |
|---|---|---|---|
| username | string | required | Username for the subuser to find associated whitelabels for. |
response = self.sg.client.whitelabel.domains.subuser.delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update the settings for a domain whitelabel.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
data = {'sample': 'data'}
domain_id = "test_url_param"
response = self.sg.client.whitelabel.domains._(domain_id).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a specific domain whitelabel.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
domain_id = "test_url_param"
response = self.sg.client.whitelabel.domains._(domain_id).get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to delete a domain whitelabel.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
domain_id = "test_url_param"
response = self.sg.client.whitelabel.domains._(domain_id).delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to associate a specific domain whitelabel with a subuser.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
Domain whitelabels can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's whitelabels. To associate a whitelabel with a subuser, the parent account must first create the whitelabel and validate it. The the parent may then associate the whitelabel via the subuser management tools.
For more information on whitelabeling, please see our User Guide
| URI Parameter | Type | Description |
|---|---|---|
| domain_id | integer | ID of the domain whitelabel to associate with the subuser. |
data = {'sample': 'data'}
domain_id = "test_url_param"
response = self.sg.client.whitelabel.domains._(domain_id).subuser.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to add an IP address to a domain whitelabel.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
| URI Parameter | Type | Description |
|---|---|---|
| id | integer | ID of the domain to which you are adding an IP |
data = {'sample': 'data'}
id = "test_url_param"
response = self.sg.client.whitelabel.domains._(id).ips.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to remove a domain's IP address from that domain's whitelabel.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
| URI Parameter | Type | Description |
|---|---|---|
| id | integer | ID of the domain whitelabel to delete the IP from. |
| ip | string | IP to remove from the domain whitelabel. |
id = "test_url_param"
ip = "test_url_param"
response = self.sg.client.whitelabel.domains._(id).ips._(ip).delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to validate a domain whitelabel. If it fails, it will return an error message describing why the whitelabel could not be validated.
A domain whitelabel allows you to remove the via or sent on behalf of message that your recipients see when they read your emails. Whitelabeling a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will be given 2 TXT records and 1 MX record.
For more information on whitelabeling, please see our User Guide
| URI Parameter | Type | Description |
|---|---|---|
| id | integer | ID of the domain whitelabel to validate. |
data = {'sample': 'data'}
id = "test_url_param"
response = self.sg.client.whitelabel.domains._(id).validate.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to create an IP whitelabel.
When creating an IP whitelable, you should use the same subdomain that you used when you created a domain whitelabel.
A IP whitelabel consists of a subdomain and domain that will be used to generate a reverse DNS record for a given IP. Once SendGrid has verified that the appropriate A record for the IP has been created, the appropriate reverse DNS record for the IP is generated.
For more information, please see our User Guide.
data = {'sample': 'data'}
response = self.sg.client.whitelabel.ips.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve all of the IP whitelabels that have been createdy by this account.
You may include a search key by using the "ip" parameter. This enables you to perform a prefix search for a given IP segment (e.g. "192.").
A IP whitelabel consists of a subdomain and domain that will be used to generate a reverse DNS record for a given IP. Once SendGrid has verified that the appropriate A record for the IP has been created, the appropriate reverse DNS record for the IP is generated.
For more information, please see our User Guide.
params = {'ip': 'test_string', 'limit': 0, 'offset': 0}
response = self.sg.client.whitelabel.ips.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve an IP whitelabel.
A IP whitelabel consists of a subdomain and domain that will be used to generate a reverse DNS record for a given IP. Once SendGrid has verified that the appropriate A record for the IP has been created, the appropriate reverse DNS record for the IP is generated.
For more information, please see our User Guide.
id = "test_url_param"
response = self.sg.client.whitelabel.ips._(id).get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to delete an IP whitelabel.
A IP whitelabel consists of a subdomain and domain that will be used to generate a reverse DNS record for a given IP. Once SendGrid has verified that the appropriate A record for the IP has been created, the appropriate reverse DNS record for the IP is generated.
For more information, please see our User Guide.
id = "test_url_param"
response = self.sg.client.whitelabel.ips._(id).delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to validate an IP whitelabel.
A IP whitelabel consists of a subdomain and domain that will be used to generate a reverse DNS record for a given IP. Once SendGrid has verified that the appropriate A record for the IP has been created, the appropriate reverse DNS record for the IP is generated.
For more information, please see our User Guide.
data = {'sample': 'data'}
id = "test_url_param"
response = self.sg.client.whitelabel.ips._(id).validate.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to create a new link whitelabel.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
data = {'sample': 'data'}
params = {'limit': 0, 'offset': 0}
response = self.sg.client.whitelabel.links.post(request_body=data, query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve all link whitelabels.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
params = {'limit': 0}
response = self.sg.client.whitelabel.links.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve the default link whitelabel.
Default link whitelabel is the actual link whitelabel to be used when sending messages. If there are multiple link whitelabels, the default is determined by the following order:
- Validated link whitelabels marked as "default"
- Legacy link whitelabels (migrated from the whitelabel wizard)
- Default SendGrid link whitelabel (i.e. 100.ct.sendgrid.net)
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
params = {'domain': 'test_string'}
response = self.sg.client.whitelabel.links.default.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve the associated link whitelabel for a subuser.
Link whitelables can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
params = {'username': 'test_string'}
response = self.sg.client.whitelabel.links.subuser.get(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to disassociate a link whitelabel from a subuser.
Link whitelables can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
params = {'username': 'test_string'}
response = self.sg.client.whitelabel.links.subuser.delete(query_params=params)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to update a specific link whitelabel. You can use this endpoint to change a link whitelabel's default status.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
data = {'sample': 'data'}
id = "test_url_param"
response = self.sg.client.whitelabel.links._(id).patch(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to retrieve a specific link whitelabel.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
id = "test_url_param"
response = self.sg.client.whitelabel.links._(id).get()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to delete a link whitelabel.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
id = "test_url_param"
response = self.sg.client.whitelabel.links._(id).delete()
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to validate a link whitelabel.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
data = {'sample': 'data'}
id = "test_url_param"
response = self.sg.client.whitelabel.links._(id).validate.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers
This endpoint allows you to associate a link whitelabel with a subuser account.
Link whitelables can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
For more information, please see our User Guide.
data = {'sample': 'data'}
link_id = "test_url_param"
response = self.sg.client.whitelabel.links._(link_id).subuser.post(request_body=data)
print response.status_code
print response.response_body
print response.response_headers