Teammates
Give and adjust account access.
Invite teammate
POST /v3/teammates
Base url: https://api.sendgrid.com
This endpoint allows you to invite a Teammate to your account via email.
You can set a Teammate's initial permissions using the scopes array in the request body. Teammate's will receive a minimum set of scopes from Twilio SendGrid that are necessary for the Teammate to function.
Note: A teammate invite will expire after 7 days, but you may resend the invitation at any time to reset the expiration date.
Authentication
- API Key
Headers
The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
Request Body
New teammate's email
maxLength: 255minLength: 5pattern: ^.*@.*\..*Set to specify list of scopes that teammate should have. Should be empty if teammate is an admin.
Set to true if teammate should be an admin user
default: False{
"email": "teammate1@example.com",
"scopes": [
"user.profile.read",
"user.profile.update"
],
"is_admin": false
}Responses
Token to identify invite
Teammate's email address
Initial set of permissions to give to teammate if they accept the invite
Set to true if teammate should have admin privileges
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.
