Twilio SendGrid Subusers
The Twilio SendGrid Subusers API allows you to create and manage your Subuser accounts. Subusers are available on [Pro and Premier…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Twilio SendGrid Subusers API allows you to create and manage your Subuser accounts. Subusers are available on Pro and Premier plans, and you can think of them as sub-accounts. Each Subuser can have its own sending domains, IP addresses, and reporting. SendGrid recommends creating Subusers for each of the different types of emails you send—one Subuser for transactional emails and another for marketing emails. Independent Software Vendor (ISV) customers may also create Subusers for each of their customers.
You can also manage Subusers in the Twilio SendGrid application user interface. See Subusers for more information.
Endpoints 14
Subusers
- GETList all Subusers
/v3/subusers?username=string&limit=0®ion=all&include_region=false&offset=0This endpoint allows you to retrieve a paginated list of all your subusers. You can use the username query parameter to filter the list for specific subusers.… - POSTCreate Subuser
/v3/subusersThis endpoint allows you to create a new subuser. - DELETEDelete a subuser
/v3/subusers/:subuser_nameThis endpoint allows you to delete a subuser. This is a permanent action. Once deleted, a subuser cannot be retrieved. - PATCHEnable/disable a subuser
/v3/subusers/:subuser_nameThis endpoint allows you to enable or disable a subuser. - GETGet the Credits for a Subuser
/v3/subusers/:subuser_name/creditsThis endpoint allows you to retrieve a Credits overview for a Subuser. - PUTUpdate the Credits for a Subuser
/v3/subusers/:subuser_name/creditsThis endpoint allows you to update the Credits for a Subuser. - PATCHUpdate the remaining credits for a Subuser
/v3/subusers/:subuser_name/credits/remainingThis endpoint allows you to update the remaining credits for a Subuser. - PUTUpdate IPs assigned to a subuser
/v3/subusers/:subuser_name/ipsThis endpoint allows you update your subusers' assigned IP. Each subuser should be assigned to an IP address from which all of this subuser's mail will be… - GETRetrieve Subuser Reputations
/v3/subusers/reputations?usernames=stringThis endpoint allows you to request the reputations for your subusers. Subuser sender reputations give a good idea how well a sender is doing with regards to…
Subuser Statistics
- GETRetrieve the monthly email statistics for a single subuser
/v3/subusers/:subuser_name/stats/monthly?date=string&sort_by_metric=delivered&sort_by_direction=desc&limit=5&offset=0This endpoint allows you to retrive the monthly email statistics for a specific subuser. When using the sort_by_metric to sort your stats by a specific… - GETRetrieve email statistics for your subusers.
/v3/subusers/stats?limit=0&offset=0&aggregated_by=day&subusers=string&start_date=string&end_date=stringThis 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… - GETRetrieve monthly stats for all subusers
/v3/subusers/stats/monthly?date=string&subuser=string&sort_by_metric=blocks&sort_by_direction=desc&limit=5&offset=0This endpoint allows you to retrieve the monthly email statistics for all subusers over the given date range. When using the sort_by_metric to sort your stats… - GETRetrieve the totals for each email statistic metric for all subusers.
/v3/subusers/stats/sums?sort_by_direction=desc&start_date=string&end_date=string&limit=5&offset=0&aggregated_by=string&sort_by_metric=deliveredThis endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.
Subuser Website Access
- PATCHEnable/Disable website access for a Subuser
/v3/subusers/:subuser_name/website_accessEnable/Disable website access for a Subuser, while still preserving email send functionality.
API details
- Base URL
https://api.sendgrid.comhttps://api.eu.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 14 operations on 11 pathsGET 7PATCH 3PUT 2POST 1DELETE 1
- Main resources
- Subusers 9Subuser Statistics 4Subuser Website Access 1
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the Twilio SendGrid Subusers in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Subusers collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List all Subusers” (GET /v3/subusers?username=string&limit=0®ion=all&include_region=false&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Subusers?
The Twilio SendGrid Subusers API allows you to create and manage your Subuser accounts. Subusers are available on [Pro and Premier… It is listed under Communication and has 14 endpoints.
Who publishes the Twilio SendGrid Subusers?
It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Twilio SendGrid Subusers?
Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Twilio SendGrid Subusers?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Subusers have?
14 operations on 11 paths (7 GET, 3 PATCH, 2 PUT, 1 POST, 1 DELETE). The largest groups are Subusers, Subuser Statistics, Subuser Website Access.
Is forking the Twilio SendGrid Subusers free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.