Skip to content
Cloudflare API
Start here
API Reference
Email Security
Settings
Impersonation Registry

Update an entry in impersonation registry

client.EmailSecurity.Settings.ImpersonationRegistry.Edit(ctx, displayNameID, params) (*SettingImpersonationRegistryEditResponse, error)
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
ParametersExpand Collapse
displayNameID int64
formatint32
params SettingImpersonationRegistryEditParams
AccountID param.Field[string]

Path param: Account Identifier

maxLength32
minLength32
Email param.Field[string]optional

Body param

IsEmailRegex param.Field[bool]optional

Body param

Name param.Field[string]optional

Body param

maxLength1024
ReturnsExpand Collapse
type SettingImpersonationRegistryEditResponse struct{…}
ID int64
formatint32
CreatedAt Time
formatdate-time
Email string
IsEmailRegex bool
LastModified Time
formatdate-time
Name string
maxLength1024
Comments stringoptional
DirectoryID int64optional
formatint64
DirectoryNodeID int64optional
formatint64
DeprecatedExternalDirectoryNodeID stringoptional
Provenance stringoptional

Update an entry in impersonation registry

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/email_security"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  response, err := client.EmailSecurity.Settings.ImpersonationRegistry.Edit(
    context.TODO(),
    int64(2403),
    email_security.SettingImpersonationRegistryEditParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.ID)
}

{
  "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
}