Skip to main content
POST
End a pod owner assignment
Sets the owner assignment’s endsAt; an end before today needs correctionReason. Send the assignment’s revision as expectedRevision; a stale value returns 409 ending (POD_OWNER_CHANGED). An assignment ID that does not resolve, or an assignment of a pod managed by or under a customer organization, returns 404. 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

podOwnerId
string
required

The pod owner assignment's ID.

Minimum string length: 1

Body

application/json
expectedRevision
integer
required

The owner assignment's revision you last read.

Required range: x >= 0
endsAt
integer
required

When the ownership ends (a UTC day boundary), epoch milliseconds.

Required range: 0 <= x <= 9007199254740991
correctionReason
string

Required by the command when the change reaches back before today (UTC).

Response

Success

data
object
required
meta
object
required