Skip to main content

sendCustomerReminder

Requires permission communications:message:send.

Sends one customer a WhatsApp reminder for an attention-list item, through the consent and send rules. Each invoice or quote is reminded at most once per cooldown period, and the customer must be in the caller's own book. Limited to 20 requests a minute. 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:

mutation SendCustomerReminder($input: CustomerReminderInput!) {
  sendCustomerReminder(input: $input) {
    deferredUntil
    queued
  }
}

Variables:

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

Response:

{
  "data": {
    "sendCustomerReminder": {
      "deferredUntil": "2025-01-15T00:00:00Z",
      "queued": true
    }
  }
}
sendCustomerReminder(
  input: CustomerReminderInput!
): CustomerReminderResultGql!

Arguments​

sendCustomerReminder.input ● CustomerReminderInput! non-null input​

The customer and the kind of reminder.

Type​

CustomerReminderResultGql object​

The result of sending a reminder.