Skip to main content

Deletes an existing integration

DELETE/jsonapi/integrations/{id}

Where id is the identifier of the integration

Deactivates the integration. A later lead submission with the same name and externalIntegrationAllowCreate enabled can reactivate it. See the external integrations and references guide.

For client-credentials integrations, supply your assigned adviser identifier in the UserId header. See request headers and data access.

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

id path required

idinteger

format: int32

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request DELETE "${API_BASE_URL}/jsonapi/integrations/{id}" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "UserId: $ADVISER_CONTACT_ID" \
  --header 'Accept: application/vnd.api+json'

Responses

204 response

No response body schema is defined for this status.

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.