Skip to content Skip to navigation Skip to topbar

Update your password

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/password

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

This endpoint allows you to update your password.

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

new_passwordstringrequired

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

old_passwordstringrequired

The old password for your account.

Responses

200

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

Update your password

Node.js

Python

Java

PHP

Ruby

curl


_22const client = require('@sendgrid/client');
_22client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22const data = {
_22  "new_password": "new_password",
_22  "old_password": "old_password"
_22};
_22
_22const request = {
_22  url: `/v3/user/password`,
_22  method: 'PUT',
_22  body: data
_22}
_22
_22client.request(request)
_22  .then(([response, body]) => {
_22    console.log(response.statusCode);
_22    console.log(response.body);
_22  })
_22  .catch(error => {
_22    console.error(error);
_22  });