Updating Integrations

PATCH Integration Attributes

Integration attributes can be updated via the PATCH HTTP Verb on the integrations endpoint.

Request Path
PATCH /api/integrations/<INTEGRATION_ID>
Request Body
{
  "data": {
      "id": "<INTEGRATION_ID>",
      "attributes": {
          "<INTEGRATION_PROPERTY>": <PROPERTY_VALUE>
      }
  }
}

Be sure to include the Content-Type header with a value of application/vnd.api+json

Example

The following example updates the Integration's "Team Subscription" flag via the autosubscribe property on the specified integration.

curl -v -X PATCH \
'https://<POLARITY_FQDN>/api/integrations/<INTEGRATION_ID>' \
--header 'Authorization: Bearer <AUTH_TOKEN>' \
--header 'Content-Type: application/vnd.api+json' \
--data-binary @- <<EOF
{
  "data": {
      "id": "<INTEGRATION_ID>",
      "attributes": {
          "autosubscribe": true
      }
  }
}
EOF

When set to true users with access to the integration will be automatically subscribed.

Integration Attributes

For a full list of attributes that can be updated via the PATCH endpoint see the integration attributes page.

Integration Attributes

Last updated