updateCompanyReportSettings

Update the PDF report customization of a company

updateCompanyReportSettings(
  input: UpdateCompanyReportSettingsInput!
): UpdateCompanyReportSettingsPayload

Arguments

updateCompanyReportSettings.input ● UpdateCompanyReportSettingsInput! non-null input

Parameters for UpdateCompanyReportSettings

Type

UpdateCompanyReportSettingsPayload object

Autogenerated return type of UpdateCompanyReportSettings.

Example request

This generated mutation 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

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"mutation MutateUpdateCompanyReportSettings($input: UpdateCompanyReportSettingsInput!) {\n  updateCompanyReportSettings(input: $input) { clientMutationId companyReportSettings { accentColor backCoverText backCoverUrl } }\n}","variables":{"input":{"companyId":"<company_id>"}}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "mutation MutateUpdateCompanyReportSettings($input: UpdateCompanyReportSettingsInput!) {\n  updateCompanyReportSettings(input: $input) { clientMutationId companyReportSettings { accentColor backCoverText backCoverUrl } }\n}",
    variables: {
    "input": {
        "companyId": "<company_id>"
    }
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "mutation MutateUpdateCompanyReportSettings($input: UpdateCompanyReportSettingsInput!) {\n  updateCompanyReportSettings(input: $input) { clientMutationId companyReportSettings { accentColor backCoverText backCoverUrl } }\n}",
        'variables': json.loads("{\"input\":{\"companyId\":\"<company_id>\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])