Saltar al contenido

Create a zone

Módulo Places

POST/zoneszones.create

An access or operations zone within a space. Creates a zone. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

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

Cuerpo de la solicitud: ZoneCreate

zones.create: ZoneCreate
CampoTipoObligatorioDescripción
space_idstring (uuid) | nullNoIdentifier of the space the zone sits in.
namestringSíZone name.Restricciones: length 1 to 300
codestringSíZone code used on credentials.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
venue_idstring (uuid)SíIdentifier of the venue.
{
  "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Backstage",
  "code": "BS",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: Zone

zones.create: Zone
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the zone.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
space_idstring (uuid) | nullSíIdentifier of the space the zone sits in.
namestringSíZone name.Restricciones: length 1 to 300
codestringSíZone code used on credentials.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
venue_idstring (uuid)SíIdentifier of the venue.
{
  "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",
  "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Backstage",
  "code": "BS",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/zones" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"space_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Backstage","code":"BS","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.zones.create({
    "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "name": "Backstage",
    "code": "BS",
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.zones.create({"space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "name": "Backstage", "code": "BS", "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos zones create --data '{"space_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Backstage","code":"BS","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'