customerReminderEligibility

Requires permission communications:message:send.

Tells whether a reminder of one kind can be sent to a customer now, and the reason when it cannot. The customer must be in the caller's own book. Requires permission to send messages.

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 CustomerReminderEligibility($input: CustomerReminderInput!) {
  customerReminderEligibility(input: $input) {
    allowed
    deferredUntil
    reason
    reasonText
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerReminderEligibility($input: CustomerReminderInput!) {\n  customerReminderEligibility(input: $input) {\n    allowed\n    deferredUntil\n    reason\n    reasonText\n  }\n}",
  "variables": {
    "input": {
      "partnerId": "id",
      "signalKey": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "partnerId": "id",
    "signalKey": "string"
  }
}

Response:

{
  "data": {
    "customerReminderEligibility": {
      "allowed": true,
      "deferredUntil": "2025-01-15T00:00:00Z",
      "reason": "string",
      "reasonText": "string"
    }
  }
}

customerReminderEligibility(
  input: CustomerReminderInput!
): CustomerReminderEligibilityGql!

Arguments

customerReminderEligibility.input ● CustomerReminderInput! non-null input

The customer and the kind of reminder.

Type

CustomerReminderEligibilityGql object

Whether a rep can send this reminder now, and if not why. It drives the disabled button and its reason.