signupPhoneCountryExceptions

Requires permission settings:organization:update.

Existing customers of your organization with a mobile or WhatsApp number from a country outside the list given, so an admin can review them before limiting sign-up phone countries. Those customers can still sign in. Needs settings:organization:update.

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 SignupPhoneCountryExceptions($countries: [String!]!) {
  signupPhoneCountryExceptions(countries: $countries) {
    total
    customers {
      code
      name
      numbers
      partnerId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SignupPhoneCountryExceptions($countries: [String!]!) {\n  signupPhoneCountryExceptions(countries: $countries) {\n    total\n    customers {\n      code\n      name\n      numbers\n      partnerId\n    }\n  }\n}",
  "variables": {
    "countries": [
      "string"
    ]
  }
}
EOF

Variables:

{
  "countries": [
    "string"
  ]
}

Response:

{
  "data": {
    "signupPhoneCountryExceptions": {
      "total": 0,
      "customers": [
        {
          "code": "string",
          "name": "string",
          "numbers": [
            "string"
          ],
          "partnerId": "string"
        }
      ]
    }
  }
}

signupPhoneCountryExceptions(
  countries: [String!]!
): SignupPhoneCountryExceptions!

Arguments

signupPhoneCountryExceptions.countries ● [String!]! non-null scalar

ISO 3166-1 alpha-2 codes of the countries sign-up would accept, such as ZA.

Type

SignupPhoneCountryExceptions object

Existing customers whose numbers fall outside a proposed sign-up phone-country list. They can still sign in; the list only limits new sign-ups.