Update an entry in impersonation registry

PATCH/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

Updates a display name entry used for impersonation protection.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloud Email Security: Write

Path ParametersExpand Collapse

account_id: string

Account Identifier

maxLength32

minLength32

display_name_id: number

formatint32

Body ParametersJSONExpand Collapse

email: optional string

is_email_regex: optional boolean

name: optional string

maxLength1024

ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

messages: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

result: { id, created_at, email, 8 more }

id: number

formatint32

created_at: string

formatdate-time

email: string

is_email_regex: boolean

last_modified: string

formatdate-time

name: string

maxLength1024

comments: optional string

directory_id: optional number

formatint64

directory_node_id: optional number

formatint64

Deprecatedexternal_directory_node_id: optional string

provenance: optional string

success: boolean

Update an entry in impersonation registry

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/email-security/settings/impersonation_registry/$DISPLAY_NAME_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{}'

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": 2403,
    "created_at": "2019-12-27T18:11:19.117Z",
    "email": "email",
    "is_email_regex": true,
    "last_modified": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "comments": "comments",
    "directory_id": 0,
    "directory_node_id": 0,
    "external_directory_node_id": "external_directory_node_id",
    "provenance": "provenance"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": 2403,
    "created_at": "2019-12-27T18:11:19.117Z",
    "email": "email",
    "is_email_regex": true,
    "last_modified": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "comments": "comments",
    "directory_id": 0,
    "directory_node_id": 0,
    "external_directory_node_id": "external_directory_node_id",
    "provenance": "provenance"
  },
  "success": true
}