Skip to main content
DELETE
Delete a future Customer assignment
Deletes an assignment that has not started yet and returns {podId, assignmentId, deleted: true}; a started assignment returns 409 ending (POD_CUSTOMER_FUTURE_ONLY) and is ended instead. Send the assignment’s revision as expectedRevision. A pod whose managing org unit is a customer organization or sits under one returns 404, exactly as a missing pod, and so does any assignment of such a pod or an assignment ID that does not resolve. 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; no customers:read is needed. 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

podCustomerAssignmentId
string
required

The Pod-to-Customer assignment's ID.

Minimum string length: 1

Body

application/json
expectedRevision
integer
required

The assignment's revision you last read; a stale value is refused.

Required range: x >= 0

Response

Success

data
object
required
meta
object
required