Cancel conversation scan

Request cancellation of a scan owned by the current user. The service rechecks permissions and returns the updated scan state.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, conversationsv3:read, wati_integration:read. API access tokens may satisfy a listed scope through the configured scope hierarchy; OIDC tokens are checked against their scope claims. Legacy JWT authentication does not use this scope check. Authentication, role, tenant, and applicable feature or plan checks still apply. For HTTP 403, check the credential type, applicable scopes, roles, and workspace access; 403 does not always mean a missing scope. Authentication/authorization failures do not guarantee a JSON response body. Allowed roles: DEVELOPER, TRIAL, ADMINISTRATOR, EXTERNAL_ADMINISTRATOR, PARTNER_ADMINISTRATOR, AI_OPERATOR, or API_TOKEN. A user with FLEXI_TRIAL or FLEXI_PAID is explicitly denied, even if another listed role is present. A qualifying outstanding invoice can also result in a 403 response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Scan ID returned by a query that starts an asynchronous scan.

Responses

401

The request is unauthorized.

403

Access denied by credential scopes, role or FLEXI exclusion, workspace permissions, or billing-related restrictions. Dunning can return JSON with an error field; other denials may have no JSON body.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json