On this page

Update API key name and scopes

API Overview

Your application, mail client, or website can all use API (Application Programming Interface) keys to authenticate access to SendGrid services. You can revoke an API key at any time without having to change your username and password, and an API key can be scoped to perform a limited number of actions.

There are 3 different types of API keys:

Full Access
Allows the API key to access GET, PATCH, PUT, DELETE and POST endpoints for all parts of your account, excluding billing and Email Address Validation.
Restricted Access
Customizes levels of access for all parts of your account, excluding billing and Email Address Validation.
Billing Access
Allows the API key to access billing endpoints for the account.

You must create your first API key using the Twilio SendGrid App. Once you have a key with permissions to manage other keys, you can use the endpoints documented as part of this API.

(warning)

Warning

Twilio SendGrid API keys are 69 characters long. We are unable to make exceptions for third-party infrastructure that is unable to support a key of 69 characters.

Operation overview

PUT/v3/api_keys/{api_key_id}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to update the name and scopes of a given API key.

You must pass this endpoint a JSON request body with a name field and a scopes array containing at least one scope. The name and scopes fields will be used to update the key associated with the api_key_id in the request URL.

If you need to update a key's scopes only, pass the name field with the key's existing name; the name will not be modified. If you need to update a key's name only, use the "Update API key name" endpoint.

See the API Key Permissions List for all available scopes.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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.

Path parameters

Property nameTypeRequiredDescription

api_key_idstringrequired

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

namestringrequired

scopesarray[string]Optional

Responses

200400401403404500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

api_key_idstring

The ID of your API Key.

namestring

The name of your API Key.

Update API key name and scopes

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const api_key_id = "ZGkrHSypTsudrGkmdpJJ";
5const data = {
6  name: "Profiles key",
7  scopes: ["user.profile.read", "user.profile.update"],
8};
9
10const request = {
11  url: `/v3/api_keys/${api_key_id}`,
12  method: "PUT",
13  body: data,
14};
15
16client
17  .request(request)
18  .then(([response, body]) => {
19    console.log(response.statusCode);
20    console.log(response.body);
21  })
22  .catch((error) => {
23    console.error(error);
24  });