Twilio SendGrid's Teammates feature allows multiple users, or "Teammates," to work from a single SendGrid account.
Teammates enables groups of users with different roles and responsibilities to share one account, where each of these users has access to varying SendGrid features depending on their needs. By only giving your individual team members access to the features that they need to do their jobs, you can limit access to sensitive areas of your account. Teammates allows you to add, remove, and manage different users. See the Teammate Permissions documentation for more information about managing user permissions.
Free and Essentials plans allow for adding one Teammate per account and do not offer Single Sign-On (SSO), while Pro and higher plans allow for up to 1,000 Teammates and include SSO and other features. Learn more about the different Email API Plans on our pricing page.
You can think of Subusers like subaccounts. Each Subuser account is its own email ecosystem with isolated contacts, templates, suppressions, and data. Subusers feed off their parent account email credits, and all billing rolls up to the parent account. Teammates may have access to a parent account, a group of Subusers, or a single Subuser account only.
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.
Bearer <<YOUR_API_KEY_HERE>>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.
application/jsonNew teammate's email
^.*@.*\..*Min length: 5Max length: 255Set 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
falseToken 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
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5email: "teammate1@example.com",6scopes: ["user.profile.read", "user.profile.update"],7is_admin: false,8};910const request = {11url: `/v3/teammates`,12method: "POST",13body: data,14};1516client17.request(request)18.then(([response, body]) => {19console.log(response.statusCode);20console.log(response.body);21})22.catch((error) => {23console.error(error);24});