Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Update API key name

API Overview

api-overview page anchor

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(link takes you to an external page). 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

operation-overview page anchor

PATCH/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 of an existing API Key.

You must pass this endpoint a JSON request body with a name property, which will be used to rename the key associated with the api_key_id passed in the URL.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstring

Optional

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

path-parameters page anchor
Property nameTypeRequiredDescription
api_key_idstring
required

Request body

request-body page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
namestring
required

The new name of the API Key.

Responses

responses page anchor
200400401403404500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
api_key_idstring

Optional

The ID of your API Key.

namestring

Optional

The name of your API Key.

Update API key nameLink to code sample: Update API key name
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const api_key_id = "ZGkrHSypTsudrGkmdpJJ";

5
const data = {

6
  name: "A New Hope",

7
};

8


9
const request = {

10
  url: `/v3/api_keys/${api_key_id}`,

11
  method: "PATCH",

12
  body: data,

13
};

14


15
client

16
  .request(request)

17
  .then(([response, body]) => {

18
    console.log(response.statusCode);

19
    console.log(response.body);

20
  })

21
  .catch((error) => {

22
    console.error(error);

23
  });