Skip to main content

PUT List addresses

PUT /v3/relay/addresses/:address_id

Updates the private email by settings the values of the parameters passed. You can only update the first private email address.

Request Headers

Accept: application/json
Authorization: Bearer {{api_key}}

Path params

ParamDescriptionExample value
address_idThe private email id1

Body data

address (string) The new alias of the private email


enabled (bool) Enable or disable this private email


block_spam (bool) Turn on or turn off block spam feature

Return

Return HTTP Status code 200 with id of the updated private email

Example

Request

curl --location --request PUT '{{host}}/v3/relay/addresses/1' \
--header 'Authorization: Bearer {{api_key}}' \
--data-raw '{
"address": "mycustomalias",
"enabled": true,
"block_spam": false
}'

Response

{
"id": 1
}