Integrations

Update the Umami integration

Configures Umami and turns it on; fields left out keep their value. Requires the admin scope and a plan with integrations.

PATCH
/sites/{site_id}/integrations/umami
cURL
curl --request PATCH \
  --url 'https://api.notiondesk.so/sites/{site_id}/integrations/umami' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "website_id": "string",
  "proxy_url": "string"
}'

Authorizations

  • Authorizationstringheader

    api_key · http · bearer

    admin
  • Authorizationstringheader

    oauth · oauth2

    admin

Path parameters

  • site_idstringrequired

    The id of a site from List sites.

Headers

  • nd-versionstring

    The contract version your integration was written against. Without it, the request uses the current version. An unknown value answers 400 invalid_version.

  • Idempotency-Keystring

    Makes a write safe to retry: the same key and body replay the first response with X-Idempotent-Replay: true. A different body answers 422 idempotency_key_reused; keys last at least 24 hours.

Body

application/jsonrequired
  • website_idstring

    Required. The Umami website id. Letters, digits, - and _ only.

  • proxy_urlstring | null

    Optional https origin to load the Umami script from; null, "" or false removes it.

Responses

The integration, with every field of its settings, null for an optional field that is not set.

Headers

  • nd-versionstring

    The contract version that answered the request.

  • X-Idempotent-Replaystring

    true when the response replays an earlier request sent with the same Idempotency-Key, otherwise false.

  • X-RateLimit-Limitinteger

    Requests allowed per minute: 120 for GET, 20 for writes, per key or OAuth grant.

  • X-RateLimit-Remaininginteger

    Requests left in the current window.

  • Retry-Afterinteger

    Seconds until the next request is accepted; 0 while requests remain.

  • typestringrequired

    The provider.

  • settingsobjectrequired

    The Umami settings.

    • website_idstringrequired

      Required. The Umami website id. Letters, digits, - and _ only.

    • proxy_urlstring | nullrequired

      Optional https origin to load the Umami script from; null, "" or false removes it.

  • enabledbooleanrequired

    Whether the site loads the provider.