The Beta endpoints for the new Email Activity APIs - functionality is subject to change without notice. You may not have access to this Beta endpoint. Email Activity offers filtering and search by event type for two days worth of data. There is an optional add-on to store 60 days worth of data. Thi
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://api.sendgrid.com/v3
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The Beta endpoints for the new Email Activity APIs - functionality is subject to change without notice. You may not have access to this Beta endpoint. Email Activity offers filtering and search by event type for two days worth of data. There is an optional add-on to store 60 days worth of data. This add-on also gives you access to the ability to download a CSV of the 60 days worth of email event
| method | path | what the vendor says it does |
|---|---|---|
GET | /access_settings/activity | Retrieve all recent access attempts **This endpoint allows you to retrieve a list of all of the IP addresses t |
GET | /access_settings/whitelist | Retrieve a list of currently allowed IPs **This endpoint allows you to retrieve a list of IP addresses that ar |
POST | /access_settings/whitelist | Add one or more IPs to the allow list **This endpoint allows you to add one or more allowed IP addresses.** T |
DELETE | /access_settings/whitelist | Remove one or more IPs from the allow list **This endpoint allows you to remove one or more IP addresses from |
GET | /access_settings/whitelist/{rule_id} | Retrieve a specific allowed IP **This endpoint allows you to retreive a specific IP address that has been allo |
DELETE | /access_settings/whitelist/{rule_id} | Remove a specific IP from the allowed list **This endpoint allows you to remove a specific IP address from you |
GET | /alerts | Retrieve all alerts **This endpoint allows you to retrieve all of your alerts.** Alerts allow you to specify |
POST | /alerts | Create a new Alert **This endpoint allows you to create a new alert.** Alerts allow you to specify an email a |
GET | /alerts/{alert_id} | Retrieve a specific alert **This endpoint allows you to retrieve a specific alert.** Alerts allow you to spec |
PATCH | /alerts/{alert_id} | Update an alert **This endpoint allows you to update an alert.** Alerts allow you to specify an email address |
DELETE | /alerts/{alert_id} | Delete an alert **This endpoint allows you to delete an alert.** Alerts allow you to specify an email address |
GET | /api_keys | Retrieve all API Keys belonging to the authenticated user **This endpoint allows you to retrieve all API Keys |
POST | /api_keys | Create API keys **This endpoint allows you to create a new API Key for the user.** To create your initial Sen |
GET | /api_keys/{api_key_id} | Retrieve an existing API Key **This endpoint allows you to retrieve a single API key using an `api_key_id`.** |
PUT | /api_keys/{api_key_id} | Update API key name and scopes **This endpoint allows you to update the name and scopes of a given API key.** |
PATCH | /api_keys/{api_key_id} | Update API key name **This endpoint allows you to update the name of an existing API Key.** You must pass thi |
DELETE | /api_keys/{api_key_id} | Delete API keys **This endpoint allows you to revoke an existing API Key using an `api_key_id`** Authenticati |
GET | /asm/groups | Retrieve all suppression groups associated with the user. **This endpoint allows you to retrieve a list of all |
POST | /asm/groups | Create a new suppression group **This endpoint allows you to create a new suppression group.** To add an emai |
GET | /asm/groups/{group_id} | Get information on a single suppression group. **This endpoint allows you to retrieve a single suppression gro |
PATCH | /asm/groups/{group_id} | Update a suppression group. **This endpoint allows you to update or change a suppression group.** Suppressions |
DELETE | /asm/groups/{group_id} | Delete a Suppression Group **This endpoint allows you to delete a suppression group.** If a recipient uses th |
GET | /asm/groups/{group_id}/suppressions | Retrieve all suppressions for a suppression group **This endpoint allows you to retrieve all suppressed email |
POST | /asm/groups/{group_id}/suppressions | Add suppressions to a suppression group **This endpoint allows you to add email addresses to an unsubscribe gr |
POST | /asm/groups/{group_id}/suppressions/search | Search for suppressions within a group **This endpoint allows you to search a suppression group for multiple s |
DELETE | /asm/groups/{group_id}/suppressions/{email} | Delete a suppression from a suppression group **This endpoint allows you to remove a suppressed email address |
GET | /asm/suppressions | Retrieve all suppressions **This endpoint allows you to retrieve a list of all suppressions.** Suppressions - |
POST | /asm/suppressions/global | Add recipient addresses to the global suppression group. **This endpoint allows you to add one or more email a |
GET | /asm/suppressions/global/{email} | Retrieve a Global Suppression **This endpoint allows you to retrieve a global suppression. You can also use th |
DELETE | /asm/suppressions/global/{email} | Delete a Global Suppression **This endpoint allows you to remove an email address from the global suppressions |
GET | /asm/suppressions/{email} | Retrieve all suppression groups for an email address **This endpoint returns a list of all groups from which t |
GET | /browsers/stats | Retrieve email statistics by browser. **This endpoint allows you to retrieve your email statistics segmented b |
GET | /campaigns | Retrieve all Campaigns **This endpoint allows you to retrieve a list of all of your campaigns.** Returns camp |
POST | /campaigns | Create a Campaign **This endpoint allows you to create a campaign.** In order to send or schedule the campaig |
GET | /campaigns/{campaign_id} | Retrieve a single campaign **This endpoint allows you to retrieve a specific campaign.** Campaigns API |
PATCH | /campaigns/{campaign_id} | Update a Campaign **This endpoint allows you to update a specific campaign.** This is especially useful if yo |
DELETE | /campaigns/{campaign_id} | Delete a Campaign **This endpoint allows you to delete a specific campaign.** Campaigns API |
GET | /campaigns/{campaign_id}/schedules | View Scheduled Time of a Campaign **This endpoint allows you to retrieve the date and time that a campaign has |
POST | /campaigns/{campaign_id}/schedules | Schedule a Campaign **This endpoint allows you to schedule a specific date and time for your campaign to be se |
PATCH | /campaigns/{campaign_id}/schedules | Update a Scheduled Campaign **This endpoint allows to you change the scheduled time and date for a campaign to |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/sendgrid/sendgrid-oai/main/oai.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.