Skip to main content
DELETE
Archive a pod
Archives an active pod and ends its open memberships, recording reason in the audit (the result does not carry it). Send the pod’s updatedAt from Get pod as expectedUpdatedAt; a stale value returns 409 ending (POD_ROSTER_CHANGED), and an archived pod refuses further changes with 409 ending (POD_ARCHIVED). A pod whose managing org unit is a customer organization or sits under one returns 404, exactly as a missing pod. The credential’s scopes must include workforce:read as well as workforce:manage, because the success returns the written row; otherwise 403 naming workforce:read, and nothing changes. workforce:manage must be held at the platform scope. Send an Idempotency-Key to make a retry safe; a same-key retry returns the recorded result only while the scopes, the platform workforce:manage and the pod’s visibility still hold, otherwise 409 idempotency_result_unavailable.

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

podId
string
required

The pod's ID.

Minimum string length: 1

Body

application/json
reason
string
required

Why the pod is archived (recorded in the audit).

Minimum string length: 1
expectedUpdatedAt
integer
required

The pod's updatedAt you last read (GET /api/v2/workforce/getPod); a stale value is refused, epoch milliseconds.

Required range: 0 <= x <= 9007199254740991

Response

Success

data
object
required
meta
object
required