setBidNotificationPreference

Requires permission biddesk:bid:read.

Sets how your phone and email hear about one kind of notice. Mentions and approvals can move to the digest but never turn off; the morning briefing is on or off. Requires Bid Desk and permission to read bids.

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 SetBidNotificationPreference($input: SetBidNotificationPreferenceInput!) {
  setBidNotificationPreference(input: $input) {
    kind
    mailMode
    push
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetBidNotificationPreference($input: SetBidNotificationPreferenceInput!) {\n  setBidNotificationPreference(input: $input) {\n    kind\n    mailMode\n    push\n  }\n}",
  "variables": {
    "input": {
      "email": "DIGEST",
      "kind": "APPROVAL",
      "push": "DIGEST"
    }
  }
}
EOF

Variables:

{
  "input": {
    "email": "DIGEST",
    "kind": "APPROVAL",
    "push": "DIGEST"
  }
}

Response:

{
  "data": {
    "setBidNotificationPreference": {
      "kind": "APPROVAL",
      "mailMode": "DIGEST",
      "push": "DIGEST"
    }
  }
}

setBidNotificationPreference(
  input: SetBidNotificationPreferenceInput!
): BidNoticePreference!

Arguments

setBidNotificationPreference.input ● SetBidNotificationPreferenceInput! non-null input

The kind and the choice for each channel.

Type

BidNoticePreference object

How phone and email hear about one kind of Bid Desk notice.