Skip to main content
POST
Assign a pod owner
Makes an active person the pod’s owner from startsAt (a UTC day boundary), with an optional endsAt. Returns 201 with the owner assignment. A pod’s owner intervals never overlap (409 ending (POD_OWNER_OVERLAP)); a start before today needs correctionReason. An unknown person returns 404, an inactive one 409. 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
personId
string
required

An active person.

Minimum string length: 1
startsAt
integer
required

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

Required range: 0 <= x <= 9007199254740991
endsAt
integer

When it 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