Menu

Teammates

Give and adjust account access.

Update teammate's permissions

Update teammate's permissions

PATCH /teammates/{username}

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

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Request Body

object
scopes
array[string]

Provide list of scopes that should be given to teammate. If specifying list of scopes, is_admin should be set to False.

required
is_admin
boolean

Set to True if this teammate should be promoted to an admin user. If True, scopes should be an empty array.

required
{
  "scopes": [
    "user.profile.read",
    "user.profile.edit"
  ],
  "is_admin": false
}

Path Parameters

username
string

The username of the teammate that you want to retrieve.

required

Responses

object
username
string

Teammate's username

first_name
string

Teammate's first name

last_name
string

Teammate's last name

email
string

Teammate's email address

scopes
array[string]

Scopes given to teammate

user_type
string

Indicate the type of user: owner user, teammate admin user, or normal teammate

Allowed Values: admin, owner, teammate
is_admin
boolean

Set to true if teammate has admin priveleges

phone
string

(optional) Teammate's phone number

website
string

(optional) Teammate's website

address
string

(optional) Teammate's address

address2
string

(optional) Teammate's address

city
string

(optional) Teammate's city

state
string

(optional) Teammate's state

zip
string

(optional) Teammate's zip

country
string

(optional) Teammate's country

object
errors
array[object]
message
string
field
string
object
errors
array[object]
message
string
field
string

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.