Skip to main content
DELETE
Delete an engagement

Authorizations

Authorization
string
header
default:Bearer <access-token>
required

Client app access token from POST https://auth.siro.ai/oauth2/token, or a legacy organization API token (Person icon → API Tokens). Send Authorization: Bearer <token>.

Path Parameters

id
string
required

Query Parameters

idType
enum<string>

Specifies whether the id path parameter is an internal engagement ID or an external ID from the source system. Defaults to internal.

Available options:
internal,
external
integrationPlatform
string

Optional override to specify integration platform if organization has multiple integrations. Only used when idType=external.

Response

200 - application/json

Delete an engagement

The response is of type boolean.