Saltar al contenido

Create a workforce group

Módulo Workforce

POST/groupsworkforceGroups.create

A group space by department, project, crew or custom audience, with its own chat and files. Creates a workforce group. 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 org.communication.write.
  • Alcances de OAuth: org.
  • 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: WorkforceGroupCreate

workforceGroups.create: WorkforceGroupCreate
CampoTipoObligatorioDescripción
namestringSíGroup name, unique in the org.Restricciones: length 1 to 120
group_kind"Department" | "Project" | "Crew" | "Custom"SíWhat the group gathers.
project_idstring (uuid) | nullNoIdentifier of the project a Project group gathers.
descriptionstring | nullNoWhat the group is for.Restricciones: length 1 to 2000
{
  "name": "Rigging Crew",
  "group_kind": "Department",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Everyone flying points."
}

Respuesta 201: WorkforceGroup

workforceGroups.create: WorkforceGroup
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the workforce group.
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íPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
namestringSíGroup name, unique in the org.Restricciones: length 1 to 120
group_kind"Department" | "Project" | "Crew" | "Custom"SíWhat the group gathers.
project_idstring (uuid) | nullSíIdentifier of the project a Project group gathers.
descriptionstring | nullSíWhat the group is for.Restricciones: length 1 to 2000
archived_atstring (date-time) | nullSíWhen the group was archived.
{
  "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": "Rigging Crew",
  "group_kind": "Department",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Everyone flying points.",
  "archived_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/groups" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Rigging Crew","group_kind":"Department","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Everyone flying points."}'
const { data } = await xos.workforceGroups.create({
    "name": "Rigging Crew",
    "group_kind": "Department",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Everyone flying points."
  });
response = xos.workforce_groups.create({"name": "Rigging Crew", "group_kind": "Department", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Everyone flying points."})
xos workforce-groups create --data '{"name":"Rigging Crew","group_kind":"Department","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Everyone flying points."}'