Skip to navigation

Cancel a Child Account onboarding intent

Beta

Cancels an intent that has not succeeded. The signer link stops working and the intent stays readable with status CANCELED. Canceling a canceled intent returns it unchanged. Answers 404 while the feature is not open to your organization.

Token scopes: organizations:write

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-02-17.

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

intent_idstringRequired
Id of the intent.

Headers

Idempotency-KeystringRequired
A UUID that identifies this cancel. A cancel is safe to repeat with any key.
X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Request

This endpoint expects an object.
dataobjectOptional
The cancellation. May be left out.

Response

The canceled intent.
dataobject
The intent.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error