provider API Keys PATCH /api_keys/{api_key_id}
@utdk/sendgrid /api_keys/{api_key_id}
Update API key name
**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.
api_key_id path required
string
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
patchApiKeysApiKeyId
PATCH/api_keys/{api_key_id}
**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.

Parameters

required

Input

required

The new name of the API Key.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.patchApiKeysApiKeyId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})