The User management REST API REST API

Email

Email APIs

Set email

PUT /users/{account_id}/manage/email

Sets the specified user's email address. Before using this endpoint, you must verify the target domain as the new email address will be considered verified. The permission to make use of this resource is exposed by the email.set privilege. This call invalidates all active sessions.

Request

Path parameters

account_id Required

string

The ID of the user

Pattern:

[a-zA-Z0-9_|:-]{1,128}

Body parameters

email Required

string

The email address of the user.

Constraints

partMaxLength: The maximum length of the user part and of any subdomain is 255 characters.
validCharacters: Control and null characters are not allowed

Example

cURL

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.atlassian.com/users/{account_id}/manage/email' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "vmars@marsinvestigations.com"
}'

Responses

204

400

401

403

404

Everything went fine, nothing to return.