Skip to main content
POST
Preview merging two people
Returns exactly what Merge persons would move for winnerId and loserId: both people, the identity claim IDs, the rows per table, the counts, and any pod ownership both hold (resourcingConflicts), which would refuse the merge. It writes nothing and takes no Idempotency-Key. Call it before every merge. Requires workforce:manage at the platform scope, and the credential’s scopes must include workforce:read as well as workforce:manage because the preview names both people (otherwise 403 naming workforce:read). A person with any seat in a customer organization or an org unit under one returns 404, exactly as an unknown person, and so does an ID merged into such a person. A self-merge returns 400; an already merged loser, or a winner merged into someone else, returns 409.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Body

application/json
winnerId
string
required

The person who remains.

Minimum string length: 1
loserId
string
required

The person merged into the winner; it becomes an inactive redirect.

Minimum string length: 1

Response

Success

data
object
required
meta
object
required