sendCustomerReminders

Requires permission communications:message:send.

Sends the same kind of reminder to several of the caller's customers at once. Each customer is checked on its own, and a customer that cannot be reminded is skipped with a reason. Limited to 5 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:

GraphQL

mutation SendCustomerReminders($input: CustomerRemindersInput!) {
  sendCustomerReminders(input: $input) {
    sent
    skipped
    outcomes {
      deferredUntil
      partnerId
      queued
      reasonText
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SendCustomerReminders($input: CustomerRemindersInput!) {\n  sendCustomerReminders(input: $input) {\n    sent\n    skipped\n    outcomes {\n      deferredUntil\n      partnerId\n      queued\n      reasonText\n    }\n  }\n}",
  "variables": {
    "input": {
      "partnerIds": [
        "id"
      ],
      "signalKey": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "partnerIds": [
      "id"
    ],
    "signalKey": "string"
  }
}

Response:

{
  "data": {
    "sendCustomerReminders": {
      "sent": 0,
      "skipped": 0,
      "outcomes": [
        {
          "deferredUntil": "2025-01-15T00:00:00Z",
          "partnerId": "id",
          "queued": true,
          "reasonText": "string"
        }
      ]
    }
  }
}

sendCustomerReminders(
  input: CustomerRemindersInput!
): CustomerRemindersResultGql!

Arguments

sendCustomerReminders.input ● CustomerRemindersInput! non-null input

The customers and the kind of reminder.

Type

CustomerRemindersResultGql object

The result of sending reminders to several customers.