SendGrid v3


The SendGrid Web API V3 Documentation

This is the entirety of the documented v3 endpoints. We have updated all the descriptions, parameters, requests, and responses.

Authentication

Every endpoint requires Authentication in the form of an Authorization Header:

Authorization: Bearer API_KEY

Resources

API Key Permissions
GET
/scopes
API Keys
DELETE
/api_keys/{api_key_id}
GET
/api_keys/{api_key_id}
PATCH
/api_keys/{api_key_id}
PUT
/api_keys/{api_key_id}
GET
/api_keys
POST
/api_keys
Alerts
DELETE
/alerts/{alert_id}
GET
/alerts/{alert_id}
PATCH
/alerts/{alert_id}
GET
/alerts
POST
/alerts
Blocks API
DELETE
/suppression/blocks/{email}
GET
/suppression/blocks/{email}
DELETE
/suppression/blocks
GET
/suppression/blocks
Bounces API
DELETE
/suppression/bounces/{email}
GET
/suppression/bounces/{email}
DELETE
/suppression/bounces
GET
/suppression/bounces
Campaigns API
POST
/campaigns/{campaign_id}/schedules/now
POST
/campaigns/{campaign_id}/schedules/test
DELETE
/campaigns/{campaign_id}/schedules
GET
/campaigns/{campaign_id}/schedules
PATCH
/campaigns/{campaign_id}/schedules
POST
/campaigns/{campaign_id}/schedules
DELETE
/campaigns/{campaign_id}
GET
/campaigns/{campaign_id}
PATCH
/campaigns/{campaign_id}
GET
/campaigns
POST
/campaigns
Cancel Scheduled Sends
GET
/mail/batch/{batch_id}
POST
/mail/batch
DELETE
/user/scheduled_sends/{batch_id}
GET
/user/scheduled_sends/{batch_id}
PATCH
/user/scheduled_sends/{batch_id}
GET
/user/scheduled_sends
POST
/user/scheduled_sends
Categories
GET
/categories/stats/sums
GET
/categories/stats
GET
/categories
Contacts API - Custom Fields
DELETE
/contactdb/custom_fields/{custom_field_id}
GET
/contactdb/custom_fields/{custom_field_id}
GET
/contactdb/custom_fields
POST
/contactdb/custom_fields
GET
/contactdb/reserved_fields
Contacts API - Lists
DELETE
/contactdb/lists/{list_id}/recipients/{recipient_id}
POST
/contactdb/lists/{list_id}/recipients/{recipient_id}
GET
/contactdb/lists/{list_id}/recipients
POST
/contactdb/lists/{list_id}/recipients
DELETE
/contactdb/lists/{list_id}
GET
/contactdb/lists/{list_id}
PATCH
/contactdb/lists/{list_id}
DELETE
/contactdb/lists
GET
/contactdb/lists
POST
/contactdb/lists
Contacts API - Recipients
GET
/contactdb/recipients/billable_count
GET
/contactdb/recipients/count
GET
GET
/contactdb/recipients/{recipient_id}/lists
DELETE
/contactdb/recipients/{recipient_id}
GET
/contactdb/recipients/{recipient_id}
DELETE
/contactdb/recipients
GET
/contactdb/recipients
PATCH
/contactdb/recipients
POST
/contactdb/recipients
GET
/contactdb/status
Contacts API - Segments
GET
/contactdb/segments/{segment_id}/recipients
DELETE
/contactdb/segments/{segment_id}
GET
/contactdb/segments/{segment_id}
PATCH
/contactdb/segments/{segment_id}
GET
/contactdb/segments
POST
/contactdb/segments