Loading...
Cross shared collection | Cenit Admin

Basic info

Title
SendGrid v3 API 3.0
Image
Thumb sendgrid v3 api 3 0 logo
Name
sendgrid_v3_api_3_0
Summary
SendGrid v3
Readme

These collection have been automatically generated from a swagger specification

API specs supplied by Image title

Authors
Name
Cenit Team
1 Cross collection authors
Pull count
0
Id
57b1ee98ad9815587a00052c
Created at
August 15, 2016 16:32
Updated at
September 23, 2016 19:56

Connectors

Connections
NamespaceNameUrlKeyTokenAuthorizationUpdated at
SendGrid v3 API 3.0HTTP Connectionhttp://api.sendgrid.com/v3 -
SendGrid v3 API 3.0HTTPS Connectionhttps://api.sendgrid.com/v3 -
2 Connections
Webhooks
NamespaceNamePathMethodDescriptionAuthorizationUpdated at
SendGrid v3 API 3.0GET Access_settings Activity/access_settings/activityget**This endpoint allows you to retrieve a list of all of the IP addresses that recently attempted to access your account either through the User Interface or the API.** IP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account. For more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html). -
SendGrid v3 API 3.0DELETE Access_settings Whitelist/access_settings/whitelistdelete**This endpoint allows you to remove one or more IPs from your IP whitelist.** You can remove one IP at a time, or you can remove multiple IP addresses. IP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account. For more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html). -
SendGrid v3 API 3.0GET Access_settings Whitelist/access_settings/whitelistget**This endpoint allows you to retrieve a list of IP addresses that are currently whitelisted.** IP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account. For more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html). -
SendGrid v3 API 3.0POST Access_settings Whitelist/access_settings/whitelistpost**This endpoint allows you to add one or more IP addresses to your IP whitelist.** When adding an IP to your whitelist, include the IP address in an array. You can whitelist one IP at a time, or you can whitelist multiple IPs at once. IP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account. For more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html). -
SendGrid v3 API 3.0DELETE Access_settings Whitelist {rule_id}/access_settings/whitelist/{{rule_id}}delete**This endpoint allows you to remove a specific IP address from your IP whitelist.** When removing a specific IP address from your whitelist, you must include the ID in your call. IP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account. For more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html). -
SendGrid v3 API 3.0GET Access_settings Whitelist {rule_id}/access_settings/whitelist/{{rule_id}}get**This endpoint allows you to retreive a specific IP address that has been whitelisted.** You must include the ID for the specific IP address you want to retrieve in your call. IP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account. For more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html). -
SendGrid v3 API 3.0GET Alerts/alertsget**This endpoint allows you to retieve all of your alerts.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly". For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html). -
SendGrid v3 API 3.0POST Alerts/alertspost**This endpoint allows you to create a new alert.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly". For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html). -
SendGrid v3 API 3.0DELETE Alerts {alert_id}/alerts/{{alert_id}}delete**This endpoint allows you to delete an alert.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly". For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html). -
SendGrid v3 API 3.0GET Alerts {alert_id}/alerts/{{alert_id}}get**This endpoint allows you to retrieve a specific alert.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly". For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html). -
SendGrid v3 API 3.0PATCH Alerts {alert_id}/alerts/{{alert_id}}patch**This endpoint allows you to update an alert.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly". For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html). -
SendGrid v3 API 3.0GET Api_keys/api_keysget**This endpoint allows you to retrieve all API Keys that belong to the authenticated user.** 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](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). -
SendGrid v3 API 3.0POST Api_keys/api_keyspost**This enpoint allows you to 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](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). See the [API Key Permissions List](https://sendgrid.com/docs/API_Reference/Web_API_v3/API_Keys/api_key_permissions_list.html) for a list of all available scopes. -
SendGrid v3 API 3.0DELETE Api_keys {api_key_id}/api_keys/{{api_key_id}}delete**This endpoint allows you to 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](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). ## URI Parameters | URI Parameter | Type | Required? | Description | |---|---|---|---| |api_key_id |string | required | The ID of the API Key you are deleting.| -
SendGrid v3 API 3.0GET Api_keys {api_key_id}/api_keys/{{api_key_id}}get**This endpoint allows you to retrieve a single api key.** If the API Key ID does not exist an HTTP 404 will be returned. -
SendGrid v3 API 3.0PATCH Api_keys {api_key_id}/api_keys/{{api_key_id}}patch**This endpoint allows you to 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](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). ## URI Parameters | URI Parameter | Type | Required? | Description | |---|---|---|---| |api_key_id |string | required | The ID of the API Key you are updating.| -
SendGrid v3 API 3.0PUT Api_keys {api_key_id}/api_keys/{{api_key_id}}put**This endpoint allows you to update the name and scopes of a given API key.** 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](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). -
SendGrid v3 API 3.0GET Asm Groups/asm/groupsget**This endpoint allows you to retrieve information about multiple suppression groups.** This endpoint will return information for each group ID that you include in your request. To add a group ID to your request, simply append `&id=` followed by the group ID. Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). Suppression groups, or [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html), allow you to label a category of content that you regularly send. This gives your recipients the ability to opt out of a specific set of your email. For example, you might define a group for your transactional email, and one for your marketing email so that your users can continue recieving your transactional email witout having to receive your marketing content. -
SendGrid v3 API 3.0POST Asm Groups/asm/groupspost**This endpoint 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. -
SendGrid v3 API 3.0DELETE Asm Groups {group_id}/asm/groups/{{group_id}}delete**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. -
SendGrid v3 API 3.0GET Asm Groups {group_id}/asm/groups/{{group_id}}get**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. -
SendGrid v3 API 3.0PATCH Asm Groups {group_id}/asm/groups/{{group_id}}patch**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. -
SendGrid v3 API 3.0GET Asm Groups {group_id} Suppressions/asm/groups/{{group_id}}/suppressionsget**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](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). 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. -
SendGrid v3 API 3.0POST Asm Groups {group_id} Suppressions/asm/groups/{{group_id}}/suppressionspost**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](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). 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. -
SendGrid v3 API 3.0POST Asm Groups {group_id} Suppressions Search/asm/groups/{{group_id}}/suppressions/searchpost**This endpoint allows you to search a suppression group for multiple suppressions.** When given a list of email addresses and a group ID, this endpoint will return only the email addresses that have been unsubscribed from the given group. Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). -
SendGrid v3 API 3.0DELETE Asm Groups {group_id} Suppressions {email}/asm/groups/{{group_id}}/suppressions/{{email}}delete**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](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). 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. -
SendGrid v3 API 3.0GET Asm Suppressions/asm/suppressionsget**This endpoint allows you to retrieve a list of all suppressions.** Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). -
SendGrid v3 API 3.0POST Asm Suppressions Global/asm/suppressions/globalpost**This endpoint allows you to add one or more email addresses to the global suppressions group.** A global suppression (or global unsubscribe) is an email address of a recipient who does not want to receive any of your messages. A globally suppressed recipient will be removed from any email you send. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Suppressions/global_unsubscribes.html). -
SendGrid v3 API 3.0DELETE Asm Suppressions Global {email}/asm/suppressions/global/{{email}}delete**This endpoint allows you to remove an email address from the global suppressions group.** A global suppression (or global unsubscribe) is an email address of a recipient who does not want to receive any of your messages. A globally suppressed recipient will be removed from any email you send. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Suppressions/global_unsubscribes.html). -
SendGrid v3 API 3.0GET Asm Suppressions Global {email}/asm/suppressions/global/{{email}}get**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.** If the email address you include in the URL path parameter `{email}` is alreayd globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned. A global suppression (or global unsubscribe) is an email address of a recipient who does not want to receive any of your messages. A globally suppressed recipient will be removed from any email you send. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Suppressions/global_unsubscribes.html). -
SendGrid v3 API 3.0GET Asm Suppressions {email}/asm/suppressions/{{email}}get**This endpoint returns the list of all groups that the given email address has been unsubscribed from.** Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). -
SendGrid v3 API 3.0GET Browsers Stats/browsers/statsget**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](https://sendgrid.com/docs/User_Guide/Statistics/index.html). -
SendGrid v3 API 3.0GET Campaigns/campaignsget**This endpoint allows you to retrieve a list of all of your campaigns.** Returns campaigns in reverse order they were created (newest first). Returns an empty array if no campaigns exist. For more information: * [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) -
SendGrid v3 API 3.0POST Campaigns/campaignspost**This endpoint allows you to create a campaign.** 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: * [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) -
SendGrid v3 API 3.0DELETE Campaigns {campaign_id}/campaigns/{{campaign_id}}delete**This endpoint allows you to delete a specific campaign.** Our Marketing Campaigns API lets you create, manage, send, and schedule campaigns. For more information: * [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) -
231 Webhooks (showing 35)
Connection Roles
NamespaceNameWebhooksConnectionsUpdated at
SendGrid v3 API 3.0HTTP Connections -
SendGrid v3 API 3.0HTTPS Connections -
2 Connection Roles

Data

Data Types
NamespaceNameSlugTypeStorage sizeUpdated at
SendGrid v3 API 3.0advanced_stats_clicksadvanced_stats_clicksJson Data Type0 Bytes -
SendGrid v3 API 3.0advanced_stats_countryadvanced_stats_countryJson Data Type0 Bytes -
SendGrid v3 API 3.0advanced_stats_mailbox_provideradvanced_stats_mailbox_providerJson Data Type0 Bytes -
SendGrid v3 API 3.0advanced_stats_opensadvanced_stats_opensJson Data Type0 Bytes -
SendGrid v3 API 3.0api_key_name_idapi_key_name_idJson Data Type0 Bytes -
SendGrid v3 API 3.0campaign_requestcampaign_requestJson Data Type0 Bytes -
SendGrid v3 API 3.0category_statscategory_statsJson Data Type0 Bytes -
SendGrid v3 API 3.0contactdb_custom_fieldcontactdb_custom_fieldJson Data Type0 Bytes -
SendGrid v3 API 3.0contactdb_listcontactdb_listJson Data Type0 Bytes -
SendGrid v3 API 3.0contactdb_recipientcontactdb_recipientJson Data Type0 Bytes -
SendGrid v3 API 3.0contactdb_recipient_countcontactdb_recipient_countJson Data Type0 Bytes -
SendGrid v3 API 3.0contactdb_recipient_responsecontactdb_recipient_responseJson Data Type0 Bytes -
SendGrid v3 API 3.0contactdb_segmentscontactdb_segmentsJson Data Type0 Bytes -
SendGrid v3 API 3.0contactdb_segments_conditionscontactdb_segments_conditionsJson Data Type0 Bytes -
SendGrid v3 API 3.0contactscontactsJson Data Type0 Bytes -
SendGrid v3 API 3.0credentialscredentialsJson Data Type0 Bytes -
SendGrid v3 API 3.0email_objectemail_objectJson Data Type0 Bytes -
SendGrid v3 API 3.0errorserrorsJson Data Type0 Bytes -
SendGrid v3 API 3.0event_webhook_settingsevent_webhook_settingsJson Data Type0 Bytes -
SendGrid v3 API 3.0global:ErrorResponseglobal_error_responseJson Data Type0 Bytes -
SendGrid v3 API 3.0global:empty_requestglobal_empty_requestJson Data Type0 Bytes -
SendGrid v3 API 3.0global:idglobal_idJson Data Type0 Bytes -
SendGrid v3 API 3.0google_analytics_settingsgoogle_analytics_settingsJson Data Type0 Bytes -
SendGrid v3 API 3.0ip_poolip_poolJson Data Type0 Bytes -
SendGrid v3 API 3.0ip_warmup_responseip_warmup_responseJson Data Type0 Bytes -
SendGrid v3 API 3.0ip_whitelabelip_whitelabelJson Data Type0 Bytes -
SendGrid v3 API 3.0link_whitelabellink_whitelabelJson Data Type0 Bytes -
SendGrid v3 API 3.0mail_batch_idmail_batch_idJson Data Type0 Bytes -
SendGrid v3 API 3.0mail_settings_address_whitelabelmail_settings_address_whitelabelJson Data Type0 Bytes -
SendGrid v3 API 3.0mail_settings_bccmail_settings_bccJson Data Type0 Bytes -
SendGrid v3 API 3.0mail_settings_bounce_purgemail_settings_bounce_purgeJson Data Type0 Bytes -
SendGrid v3 API 3.0mail_settings_footermail_settings_footerJson Data Type0 Bytes -
SendGrid v3 API 3.0mail_settings_forward_bouncemail_settings_forward_bounceJson Data Type0 Bytes -
SendGrid v3 API 3.0mail_settings_forward_spammail_settings_forward_spamJson Data Type0 Bytes -
SendGrid v3 API 3.0mail_settings_patchmail_settings_patchJson Data Type0 Bytes -
55 Data Types (showing 35)

Config

Namespaces
NameSlugUpdated at
SendGrid v3 API 3.0sendgrid_v3_api_3_0 -
1 Namespaces

Metadata