contactIdentityConflicts

Requires at least one of the permissions customers:customer:create or customers:customer:update.

Checks whether the given emails or mobile numbers already belong to another person, on this customer or another, so a contact form can warn before saving. A restricted rep never learns which out-of-scope customer holds a value. Needs the customers create or update permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ContactIdentityConflicts($input: ContactIdentityCheckInput!) {
  contactIdentityConflicts(input: $input) {
    partnerCode
    contactName
    partnerName
    channel
    message
    partnerId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ContactIdentityConflicts($input: ContactIdentityCheckInput!) {\n  contactIdentityConflicts(input: $input) {\n    partnerCode\n    contactName\n    partnerName\n    channel\n    message\n    partnerId\n  }\n}",
  "variables": {
    "input": {
      "emails": [
        "string"
      ],
      "phones": [
        "string"
      ]
    }
  }
}
EOF

Variables:

{
  "input": {
    "emails": [
      "string"
    ],
    "phones": [
      "string"
    ]
  }
}

Response:

{
  "data": {
    "contactIdentityConflicts": [
      {
        "partnerCode": "string",
        "contactName": "string",
        "partnerName": "string",
        "channel": "string",
        "message": "string",
        "partnerId": "id"
      }
    ]
  }
}

contactIdentityConflicts(
  input: ContactIdentityCheckInput!
): [ContactIdentityConflictInfo!]!

Arguments

contactIdentityConflicts.input ● ContactIdentityCheckInput! non-null input

The emails and mobile numbers to check.

Type

ContactIdentityConflictInfo object

Another contact that already uses an email address or phone number.