sendGovernorSettings

Requires permission settings:integration:read.

Returns the organization's marketing send rules: whether marketing is on, the weekly cap per contact, the daily cap per customer and the daily send window. Requires permission to read integrations.

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 SendGovernorSettings {
  sendGovernorSettings {
    dailyCapPerPartner
    marketingEnabled
    sendWindowCloseHour
    sendWindowOpenHour
    weeklyCapPerContact
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SendGovernorSettings {\n  sendGovernorSettings {\n    dailyCapPerPartner\n    marketingEnabled\n    sendWindowCloseHour\n    sendWindowOpenHour\n    weeklyCapPerContact\n  }\n}"
}
EOF

Response:

{
  "data": {
    "sendGovernorSettings": {
      "dailyCapPerPartner": 0,
      "marketingEnabled": true,
      "sendWindowCloseHour": 0,
      "sendWindowOpenHour": 0,
      "weeklyCapPerContact": 0
    }
  }
}

sendGovernorSettings: SendGovernorSettingsGql!

Type

SendGovernorSettingsGql object

The organization's rules for sending marketing messages.