Create an onboarding item

Módulo Opportunities

POST/onboarding-itemsonboardingItems.create

One onboarding requirement instantiated for an engagement. Creates an onboarding item. 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 opportunities.onboarding.write.
Alcances de OAuth: opportunities.
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: OnboardingItemCreate

onboardingItems.create: OnboardingItemCreate
Campo	Tipo	Obligatorio	Descripción
engagement_id	string (uuid)	Sí	Identifier of the engagement.
onboarding_requirement_id	string (uuid)	Sí	Identifier of the onboarding requirement.

{
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "onboarding_requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: OnboardingItem

onboardingItems.create: OnboardingItem
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the onboarding item.
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.
engagement_id	string (uuid)	Sí	Identifier of the engagement.
onboarding_requirement_id	string (uuid)	Sí	Identifier of the onboarding requirement.
document_id	string (uuid) \| null	Sí	Identifier of the submitted document.
onboarding_item_state	string	Sí	Item state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
expires_on	string (date) \| null	Sí	Expiry.
carried_over	boolean	Sí	Whether a verified item carried over from an earlier engagement.
submitted_at	string (date-time) \| null	Sí	When the engaged party submitted the item.

{
  "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",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "onboarding_requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "onboarding_item_state": "In Review",
  "expires_on": "2026-10-08",
  "carried_over": false,
  "submitted_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/onboarding-items" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","onboarding_requirement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.onboardingItems.create({
    "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "onboarding_requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.onboarding_items.create({"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "onboarding_requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos onboarding-items create --data '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","onboarding_requirement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'