Skip to main content
POST
Set a pod's internal delivery profile
Classifies the pod’s internal (non-Customer) delivery from effectiveAt by deliveryType and/or reporting categoryKey. Name the profile this one succeeds in previousId with its expectedRevision, or send both null for the pod’s first profile; at the predecessor’s own start the row is corrected in place. A previousId that names no profile of this pod returns 404. A profile cannot overlap another profile or any Customer assignment of the pod (409 ending (POD_INTERNAL_PROFILE_CONFLICT)); an unknown or retired category returns 400. 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
effectiveAt
integer
required

When the profile takes effect (a UTC day boundary), epoch milliseconds.

Required range: 0 <= x <= 9007199254740991
previousId
string | null
required

The profile this one succeeds, or null for the pod's first profile.

Minimum string length: 1
expectedRevision
integer | null
required

previousId's revision, or null with a null previousId.

Required range: x >= 0
deliveryType
enum<string>
Available options:
msp,
project,
platform,
forward_deployed
categoryKey
string

An active reporting category key.

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