Subusers API
For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console.
Create Subuser
POST /v3/subusers
Base url: https://api.sendgrid.com
This endpoint allows you to create a new subuser.
Authentication
- API Key
Headers
Request Body
The username for this subuser.
The email address of the subuser.
format: emailThe password this subuser will use when logging into SendGrid.
The IP addresses that should be assigned to this subuser.
The region this subuser should be assigned to. Can be global or eu. (Regional email is in Public Beta and requires SendGrid Pro plan or above.).
A flag that determines if the subuser's region should be returned in the response. (Regional email is in Public Beta and requires SendGrid Pro plan or above.)
default: False{
"username": "John@example.com",
"email": "John@example.com",
"password": "johns_password",
"ips": [
"1.1.1.1",
"2.2.2.2"
],
"region": "global",
"include_region": true
}Responses
The username of the subuser.
The user ID for this subuser.
The email address for this subuser.
format: emailThe region this subuser is assigned to. Only returned if include_region was set to true in the request.
{
"username": "example_subuser",
"user_id": 1234,
"email": "example@example.com",
"credit_allocation": {
"type": "unlimited"
},
"region": "global"
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
