Skip to main content

notificationPreferences

Returns notifications preferences

notificationPreferences(
companyId: ID!
integrationId: ID
): [PreferencesType!]!

Arguments​

notificationPreferences.companyId ● ID! non-null scalar​

notificationPreferences.integrationId ● ID scalar​

Type​

PreferencesType object​

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the companies query first and use data.companies.collection[].id as companyId.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetNotificationPreferences($companyId: ID!) {\n notificationPreferences(companyId: $companyId) { id name enabled }\n}","variables":{"companyId":"<company_id>"}}'

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute