Skip to main content

PUT Enable/Disable email address

PUT /v3/relay/addresses/:address_id/enabled

You can use this API to enable or disable your Private Email.

Request Headers

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

Path params

ParamDescriptionExample value
address_idThe private email id1

Body data

This API does not require any body data

Return

Return HTTP status code 200 with:

  • id (int) The id of updated object

  • enabled (bool) The private email is enabled or not

Example

Request

curl --location --request PUT '{{host}}/v3/relay/addresses/1/enabled' \
--header 'Authorization: Bearer {{api_key}}' \
--data-raw ''

Response

{
"id": 1,
"enabled": false
}