Skip to main content
POST
Cancel an onboarding

Authorizations

Authorization
string
header
required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Path Parameters

key
string<uuid>
required

Body

userKey
string<uuid>
approverUserKey
string<uuid> | null
paused
boolean | null
engagementKey
string<uuid> | null

Response

200

OK