Skip to main content
PUT
Move a project to a chosen address

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128
If-Match
string
required

Exact ETag returned for the current project or deployment state.

Required string length: 3 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
handle
string
required

One to five lowercase words of letters and digits.

Required string length: 3 - 59
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+){0,4}$

Response

The mutation was accepted for asynchronous processing.

Durable record returned for an accepted asynchronous mutation. Optional reconciliation is a current observation for queued/running work, separate from immutable terminal state. A completed reconciliation attempt alone does not mean the operation succeeded.

id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
state
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
created_at
string<date-time>
required
updated_at
string<date-time>
required
blocking_operation_id
string

The active operation holding this queued operation's project mutation claim.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
result
object
error
object
progress
object

Current deployment dependency observation, separate from immutable operation history. Poll the same operation; mail readiness does not mean application activation.

reconciliation
object