Create an opportunity position
Módulo Opportunities
POST/opportunity-positionsopportunityPositions.create
A position within an opportunity. Creates an opportunity position. 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.posting.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: OpportunityPositionCreate
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| opportunity_id | string (uuid) | Sí | Identifier of the opportunity. |
| label | string | Sí | Position label, for example Rigger 2.Restricciones: length 1 to 300 |
| call_at | string (date-time) | null | No | Call time. |
| ends_at | string (date-time) | null | No | When the position's work ends. |
{
"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"label": "Rigger 2",
"call_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z"
}Respuesta 201: OpportunityPosition
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the opportunity position. |
| 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. |
| opportunity_id | string (uuid) | Sí | Identifier of the opportunity. |
| label | string | Sí | Position label, for example Rigger 2.Restricciones: length 1 to 300 |
| call_at | string (date-time) | null | Sí | Call time. |
| ends_at | string (date-time) | null | Sí | When the position's work ends. |
{
"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",
"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"label": "Rigger 2",
"call_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X POST "$XOS_BASE_URL/opportunity-positions" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"opportunity_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","label":"Rigger 2","call_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z"}'const { data } = await xos.opportunityPositions.create({
"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"label": "Rigger 2",
"call_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z"
});response = xos.opportunity_positions.create({"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "label": "Rigger 2", "call_at": "2026-10-08T14:30:00Z", "ends_at": "2026-10-08T14:30:00Z"})xos opportunity-positions create --data '{"opportunity_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","label":"Rigger 2","call_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z"}'