Updating the subscriber's email address

Learn how to update the subscriber's email address.

A long-term subscriber sometimes needs to change their subscription email address. Use the POST /v1/subscriptons/{subscriptionId}/email to update a subscription customer's ship-to and bill-to email address so they can receive notifications. You need to include the email address (emailAddress). The email address should use a valid email format and not exceed 255 characters. In the following example, the value of the emailAddress is [email protected].

cURL
cURL
curl --location --request POST 'http://{host}/v1/subscriptions/{subscriptionId}/email' \
--header 'Content-Type: application/json' \
--header 'authorization: bearer ***\
--data-raw '{
"emailAddress" : "[email protected]"
}'

You will receive a 202 Accepted response.

If the email address format is missing, you will see 400 Bad Request error message with a validation-error code.

JSON
JSON
{
"errors": {
"error": [
{
"code": "validation-error",
"subcode": "required-data-missing",
"description": "Missing required field: emailAddress"
}
]
}
}