Skip to content Skip to navigation Skip to topbar

Update your username

API Overview

Keeping your user profile up to date helps SendGrid verify who you are and share important communications with you.

You can learn more in the SendGrid Account Details documentation.

Operation overview

PUT/v3/user/username

Base url: https://api.sendgrid.com

This endpoint allows you to update the username for your account.

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.

Request body

SchemaExample

Property nameTypeRequiredDescriptionChild properties

usernamestringOptional

The new username you would like to use for your account.

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

usernamestring

The current username on file for your account.

Update your username

Node.js

Python

Java

PHP

Ruby

curl


_21const client = require('@sendgrid/client');
_21client.setApiKey(process.env.SENDGRID_API_KEY);
_21
_21const data = {
_21  "username": "test_username"
_21};
_21
_21const request = {
_21  url: `/v3/user/username`,
_21  method: 'PUT',
_21  body: data
_21}
_21
_21client.request(request)
_21  .then(([response, body]) => {
_21    console.log(response.statusCode);
_21    console.log(response.body);
_21  })
_21  .catch(error => {
_21    console.error(error);
_21  });