Menu

Rate this page:

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

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
email
string

New teammate's email

maxLength: 255minLength: 5pattern: ^.*@.*\..*
required
scopes
array[string]

Set to specify list of scopes that teammate should have. Should be empty if teammate is an admin.

required
is_admin
boolean

Set to true if teammate should be an admin user

default: False
required
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}

Responses

object
token
string

Token to identify invite

email
string

Teammate's email address

scopes
array[]

Initial set of permissions to give to teammate if they accept the invite

is_admin
boolean

Set to true if teammate should have admin privileges

object
errors
array[object]
message
string
field
string
        
        
        
        Rate this page:

        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.

              
              
              

              Thank you for your feedback!

              We are always striving to improve our documentation quality, and your feedback is valuable to us. Please select the reason(s) for your feedback or provide additional information about how we can improve:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more