Teammates
Give and adjust account access.
Update teammate's permissions
PATCH /v3/teammates/{username}
Base url: https://api.sendgrid.com
This endpoint allows you to update a teammate’s permissions.
To turn a teammate into an admin, the request body should contain an is_admin set to true. Otherwise, set is_admin to false and pass in all the scopes that a teammate should have.
Only the parent user or other admin teammates can update another teammate’s permissions.
Admin users can only update permissions.
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
Provide list of scopes that should be given to teammate. If specifying list of scopes, is_admin should be set to False.
Set to True if this teammate should be promoted to an admin user. If True, scopes should be an empty array.
{
"scopes": [
"user.profile.read",
"user.profile.edit"
],
"is_admin": false
}Path Parameters
The username of the teammate that you want to retrieve.
default: NoneResponses
Teammate's username
Teammate's first name
Teammate's last name
Teammate's email address
Scopes given to teammate
Indicate the type of user: owner user, teammate admin user, or normal teammate
Allowed Values: admin, owner, teammateSet to true if teammate has admin priveleges
(optional) Teammate's phone number
(optional) Teammate's website
(optional) Teammate's address
(optional) Teammate's address
(optional) Teammate's city
(optional) Teammate's state
(optional) Teammate's zip
(optional) Teammate's country
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.
