updateSendGovernorSettings

Requires permission settings:integration:update.

Changes the organization's marketing send rules. Omitted fields keep their current value, and the send window must close after it opens. Requires permission to update 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

mutation UpdateSendGovernorSettings($input: UpdateSendGovernorSettingsInput!) {
  updateSendGovernorSettings(input: $input) {
    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": "mutation UpdateSendGovernorSettings($input: UpdateSendGovernorSettingsInput!) {\n  updateSendGovernorSettings(input: $input) {\n    dailyCapPerPartner\n    marketingEnabled\n    sendWindowCloseHour\n    sendWindowOpenHour\n    weeklyCapPerContact\n  }\n}",
  "variables": {
    "input": {}
  }
}
EOF

Variables:

{
  "input": {}
}

Response:

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

updateSendGovernorSettings(
  input: UpdateSendGovernorSettingsInput!
): SendGovernorSettingsGql!

Arguments

updateSendGovernorSettings.input ● UpdateSendGovernorSettingsInput! non-null input

The fields to change: marketing on or off, weekly and daily caps, and the send window hours.

Type

SendGovernorSettingsGql object

The organization's rules for sending marketing messages.