setMessagingAppSelection

Requires permission settings:apps:install.

Choose the installed app that sends reminder messages (invoice reminders, expiring quotes, abandoned carts). The app must be installed, active and hold read_customer_pii. Replaces any earlier choice.

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 SetMessagingAppSelection($input: SetMessagingAppSelectionInput!) {
  setMessagingAppSelection(input: $input) {
    channel
    installationId
    updatedAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetMessagingAppSelection($input: SetMessagingAppSelectionInput!) {\n  setMessagingAppSelection(input: $input) {\n    channel\n    installationId\n    updatedAt\n  }\n}",
  "variables": {
    "input": {
      "channel": "EMAIL",
      "installationId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "channel": "EMAIL",
    "installationId": "id"
  }
}

Response:

{
  "data": {
    "setMessagingAppSelection": {
      "channel": "EMAIL",
      "installationId": "id",
      "updatedAt": "2025-01-15T00:00:00Z"
    }
  }
}

setMessagingAppSelection(
  input: SetMessagingAppSelectionInput!
): MessagingAppSelectionView!

Arguments

setMessagingAppSelection.input ● SetMessagingAppSelectionInput! non-null input

The app and the channel it sends on.

Type

MessagingAppSelectionView object

The installed app that sends this organization's reminder messages (invoice reminders, expiring quotes, abandoned carts), and on which channel.