Skip to main content
POST
Revoke a person's email claim
Revokes one of the person’s email claims and records it, with reason, on the person’s history. Revoking a claim that is already revoked keeps its original revocation time and reason and returns outcome: ALREADY_REVOKED. A claim that is not the person’s returns 404 Email claim not found. The credential’s scopes must include workforce:read as well as workforce:manage, because the success returns the person’s record; otherwise 403 naming workforce:read, and nothing changes. Requires workforce:manage at the platform scope; a key or app whose grant covers only some org units receives 403. 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 merged-away ID otherwise resolves to the person it was merged into. Send an Idempotency-Key to make a retry safe: a same-key retry within 24 hours returns the recorded result only while your scopes still include workforce:read, you still hold workforce:manage at the platform scope, and the person the result names is still in reach; otherwise 409 idempotency_result_unavailable, and the change is never made twice (see Idempotency). Without a key, a repeat returns 200 with outcome: ALREADY_REVOKED.

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.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

personId
string
required

The person's ID (a merged-away ID resolves to the person it was merged into).

Minimum string length: 1
claimId
string
required

One of the person's email claim IDs (GET listPersonEmailClaims).

Minimum string length: 1

Body

application/json
reason
string
required

Why the claim is revoked. Recorded in the audit.

Response

Success

data
object
required
meta
object
required