Skip to main content
POST

Authorizations

Authorization
string
header
required

Source-bound WorkOS API key or configured machine OIDC token. OIDC webhook management requires karsa:webhooks:manage.

Headers

Idempotency-Key
string
required

Stable source submission identifier, unique for this source and route

Required string length: 1 - 200
Example:

"01J9ZQ2YD15Y2YZ5H0W3J7D3E2"

Body

application/json
externalId
string
required
Required string length: 1 - 200
effectiveAt
string<date-time>
required
documentType
string | null
required
Required string length: 1 - 200
displayName
string | null
required
Required string length: 1 - 500
contentType
string
required
Required string length: 1 - 200
contentBase64
string
required
Required string length: 1 - 16777216
sourceExternalId
string | null
Required string length: 1 - 200
changeReason
string | null
Required string length: 1 - 500

Response

A new immutable version was appended to an existing identity

outcome
enum<string>
required
Available options:
CREATED,
VERSION_CREATED
resourceId
string
required
Minimum string length: 1
versionId
string
required
Minimum string length: 1
currentVersionId
string | null
required
Minimum string length: 1