# 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. * **Custom 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](https://app.sendgrid.com/settings/api_keys). Once you have a key with permissions to manage other keys, you can use the endpoints documented as part of this API. > \[!WARNING] > > Twilio SendGrid API keys are 69 characters long. Twilio can't make exceptions for third-party infrastructure unable to support a key of 69 characters. ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/api_keys/{api_key_id}","method":"put","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"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](/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/authorization) for all available scopes. ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}},{"name":"on-behalf-of","in":"header","description":"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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.","required":false,"schema":{"type":"string"},"refName":"#/components/parameters/OnBehalfOf","modelName":"__components_parameters_OnBehalfOf"}] ``` ### Path parameters ```json [{"name":"api_key_id","in":"path","description":"","required":true,"schema":{"type":"string"}}] ``` ### Request body ```json {"schema":{"type":"object","required":["name"],"example":{"name":"Profiles key","scopes":["user.profile.read","user.profile.update"]},"properties":{"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"title":"API Key Name and ID","type":"object","example":{"api_key_id":"qfTQ6KG0QBiwWdJ0-pCLCA","name":"Mail Send"},"refName":"ApiKeyResponse","modelName":"ApiKeyResponse","properties":{"api_key_id":{"type":"string","description":"The ID of your API Key. "},"name":{"type":"string","description":"The name of your API Key."}}},"examples":{"response":{"value":{"api_key_id":"qfTQ6KG0QBiwWdJ0-pCLCA","name":"Profiles Key","scopes":["user.profile.read","user.profile.update"]}}}}}}},{"responseCode":"400","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}}}},"refName":"#/components/responses/ApiKeysError400","modelName":"__components_responses_ApiKeysError400"}},{"responseCode":"401","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}}}},"refName":"#/components/responses/GlobalError401","modelName":"__components_responses_GlobalError401"}},{"responseCode":"403","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}}}},"refName":"#/components/responses/GlobalError403","modelName":"__components_responses_GlobalError403"}},{"responseCode":"404","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}}}},"refName":"#/components/responses/GlobalError404","modelName":"__components_responses_GlobalError404"}},{"responseCode":"500","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"refName":"#/components/responses/GlobalError500","modelName":"__components_responses_GlobalError500"}}] ``` Update API key name and scopes ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const api_key_id = "ZGkrHSypTsudrGkmdpJJ"; const data = { name: "Profiles key", scopes: ["user.profile.read", "user.profile.update"], }; const request = { url: `/v3/api_keys/${api_key_id}`, method: "PUT", body: data, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) api_key_id = "ZGkrHSypTsudrGkmdpJJ" data = { "name": "Profiles key", "scopes": ["user.profile.read", "user.profile.update"], } response = sg.client.api_keys._(api_key_id).put(request_body=data) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var apiKeyId = "ZGkrHSypTsudrGkmdpJJ"; var data = @"{ ""name"": ""Profiles key"", ""scopes"": [ ""user.profile.read"", ""user.profile.update"" ] }"; var response = await client.RequestAsync( method: SendGridClient.Method.PUT, urlPath: $"api_keys/{apiKeyId}", requestBody: data); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; import org.json.JSONObject; import java.util.HashMap; import java.util.Arrays; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.PUT); request.setEndpoint("/api_keys/ZGkrHSypTsudrGkmdpJJ"); request.setBody(new JSONObject(new HashMap() { { put("name", "Profiles key"); put("scopes", Arrays.asList("user.profile.read", "user.profile.update")); } }).toString()); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/api_keys/ZGkrHSypTsudrGkmdpJJ", host) request.Method = "PUT" request.Body = []byte(`{ "name": "Profiles key", "scopes": [ "user.profile.read", "user.profile.update" ] }`) response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $request_body = json_decode('{ "name": "Profiles key", "scopes": [ "user.profile.read", "user.profile.update" ] }'); $api_key_id = "ZGkrHSypTsudrGkmdpJJ"; try { $response = $sg->client ->api_keys() ->_($api_key_id) ->put($request_body); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) api_key_id = "ZGkrHSypTsudrGkmdpJJ" data = JSON.parse('{ "name": "Profiles key", "scopes": [ "user.profile.read", "user.profile.update" ] }') response = sg.client.api_keys._(api_key_id).put(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X PUT "https://api.sendgrid.com/v3/api_keys/ZGkrHSypTsudrGkmdpJJ" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"name": "Profiles key", "scopes": ["user.profile.read", "user.profile.update"]}' ```