Saltar al contenido

Create a venue

Módulo Places

POST/venuesvenues.create

A venue. Creates a venue. 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.venue.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: VenueCreate

venues.create: VenueCreate
CampoTipoObligatorioDescripción
namestringSíVenue name.Restricciones: length 1 to 300
street_addressstring | nullNoStreet address.Restricciones: length 1 to 300
localitystring | nullNoCity.Restricciones: length 1 to 300
postal_codestring | nullNoPostal code.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
jurisdiction_idJurisdictionIdSíJurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
time_zonestringSíIANA time zone the local time was entered in.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
latitudenumber | nullNoWGS 84 latitude.Restricciones: range -90 to 90
longitudenumber | nullNoWGS 84 longitude.Restricciones: range -180 to 180
{
  "name": "Harborfront Lawn",
  "street_address": "100 Harbor Way",
  "locality": "Miami",
  "postal_code": "33132",
  "jurisdiction_id": "US-FL",
  "time_zone": "America/New_York",
  "latitude": 25.7617,
  "longitude": -80.1918
}

Respuesta 201: Venue

venues.create: Venue
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the venue.
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.
namestringSíVenue name.Restricciones: length 1 to 300
street_addressstring | nullSíStreet address.Restricciones: length 1 to 300
localitystring | nullSíCity.Restricciones: length 1 to 300
postal_codestring | nullSíPostal code.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
jurisdiction_idJurisdictionIdSíJurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
time_zonestringSíIANA time zone the local time was entered in.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
latitudenumber | nullSíWGS 84 latitude.Restricciones: range -90 to 90
longitudenumber | nullSíWGS 84 longitude.Restricciones: range -180 to 180
{
  "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",
  "name": "Harborfront Lawn",
  "street_address": "100 Harbor Way",
  "locality": "Miami",
  "postal_code": "33132",
  "jurisdiction_id": "US-FL",
  "time_zone": "America/New_York",
  "latitude": 25.7617,
  "longitude": -80.1918
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/venues" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Harborfront Lawn","street_address":"100 Harbor Way","locality":"Miami","postal_code":"33132","jurisdiction_id":"US-FL","time_zone":"America/New_York","latitude":25.7617,"longitude":-80.1918}'
const { data } = await xos.venues.create({
    "name": "Harborfront Lawn",
    "street_address": "100 Harbor Way",
    "locality": "Miami",
    "postal_code": "33132",
    "jurisdiction_id": "US-FL",
    "time_zone": "America/New_York",
    "latitude": 25.7617,
    "longitude": -80.1918
  });
response = xos.venues.create({"name": "Harborfront Lawn", "street_address": "100 Harbor Way", "locality": "Miami", "postal_code": "33132", "jurisdiction_id": "US-FL", "time_zone": "America/New_York", "latitude": 25.7617, "longitude": -80.1918})
xos venues create --data '{"name":"Harborfront Lawn","street_address":"100 Harbor Way","locality":"Miami","postal_code":"33132","jurisdiction_id":"US-FL","time_zone":"America/New_York","latitude":25.7617,"longitude":-80.1918}'