Restore an archived project

Módulo Projects

POST/projects/{id}/unarchiveprojects.unarchive

Clears `archived_at`, so the project returns to the default lists. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad projects.project.archive.
Alcances de OAuth: projects.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

projects.unarchive: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the project.

Respuesta 200: Project

projects.unarchive: Project
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the project.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_key	string	Sí	Project key, chosen by the caller and unique in the organization; it addresses the project in Atlas URLs.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
name	string	Sí	Project name, Title Case.Restricciones: length 1 to 300
description	string \| null	Sí	Project description.Restricciones: length 1 to 20000
workspace_id	string (uuid) \| null	Sí	Identifier of the workspace.
jurisdiction_id	JurisdictionId	Sí	Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
region_code	RegionCode	Sí	Cost region code from `xpms.dim_region`.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)+$
tier_code	TierCode \| null	Sí
current_phase_code	PhaseCode	Sí	Phase code from `xpms.dim_phase`, ordered by gate ordinal.Restricciones: pattern ^[A-Z]{3}$
project_state	string	Sí	Project lifecycle state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
currency	string	Sí	Base currency of the project.Restricciones: pattern ^[A-Z]{3}$
starts_on	string (date) \| null	Sí	First show day.
ends_on	string (date) \| null	Sí	Last show day.
time_zone	string	Sí	IANA time zone of the project; local times are entered in it.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
venue_id	string (uuid) \| null	Sí	Identifier of the primary venue of the project.
client_counterparty_id	string (uuid) \| null	Sí	Identifier of the client counterparty the project is produced for.
production_state	string	Sí	Production lifecycle state, which runs beside the project state; changes only through its transition RPC. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
archived_at	string (date-time) \| null	Sí	When the project was archived; archived projects leave the default lists.
anchor_on	string (date) \| null	Sí	Anchor date (usually the show day) that template day offsets count from.
budget_envelope_minor	integer (int64) \| null	Sí	Budget envelope approved for the project. Integer minor units of the resource currency; null means unpriced, never zero.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_key": "NWL-24",
  "name": "Harborfront Summer Series",
  "description": "Six weekend shows on the harbor lawn.",
  "workspace_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "jurisdiction_id": "US-FL",
  "region_code": "NA-SE-MIA",
  "tier_code": "04",
  "current_phase_code": "SCP",
  "project_state": "Active",
  "currency": "USD",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08",
  "time_zone": "America/New_York",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "client_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "production_state": "Proposed",
  "archived_at": "2026-10-08T14:30:00Z",
  "anchor_on": "2026-10-08",
  "budget_envelope_minor": 25000000
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/projects/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/unarchive" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const { data } = await xos.projects.unarchive("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.projects.unarchive("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos projects unarchive 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f