Saltar al contenido

Create a pool member

Módulo Opportunities

POST/pool-memberspoolMembers.create

A pool member. Do Not Engage needs a reason and a review date and is never visible externally. Creates a pool member. 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.pool.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: PoolMemberCreate

poolMembers.create: PoolMemberCreate
CampoTipoObligatorioDescripción
talent_pool_idstring (uuid)SíIdentifier of the pool.
person_idstring (uuid) | nullNoIdentifier of the member person.
organization_idstring (uuid) | nullNoIdentifier of the member organization.
levelPoolLevelSíTalent or vendor pool level. Do Not Engage is internal only and needs a reason and review date.Restricciones: one of "Preferred", "Approved", "Do Not Engage"
reasonstring | nullNoReason, required for Do Not Engage.Restricciones: length 1 to 20000
review_onstring (date) | nullNoReview date, required for Do Not Engage.
rehire_eligiblebooleanSíRehire eligibility.
{
  "talent_pool_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "level": "Preferred",
  "reason": "Repeated no-shows.",
  "review_on": "2026-10-08",
  "rehire_eligible": true
}

Respuesta 201: PoolMember

poolMembers.create: PoolMember
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the pool member.
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.
talent_pool_idstring (uuid)SíIdentifier of the pool.
person_idstring (uuid) | nullSíIdentifier of the member person.
organization_idstring (uuid) | nullSíIdentifier of the member organization.
levelPoolLevelSíTalent or vendor pool level. Do Not Engage is internal only and needs a reason and review date.Restricciones: one of "Preferred", "Approved", "Do Not Engage"
reasonstring | nullSíReason, required for Do Not Engage.Restricciones: length 1 to 20000
review_onstring (date) | nullSíReview date, required for Do Not Engage.
rehire_eligiblebooleanSíRehire eligibility.
{
  "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",
  "talent_pool_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "level": "Preferred",
  "reason": "Repeated no-shows.",
  "review_on": "2026-10-08",
  "rehire_eligible": true
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/pool-members" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"talent_pool_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","level":"Preferred","reason":"Repeated no-shows.","review_on":"2026-10-08","rehire_eligible":true}'
const { data } = await xos.poolMembers.create({
    "talent_pool_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "level": "Preferred",
    "reason": "Repeated no-shows.",
    "review_on": "2026-10-08",
    "rehire_eligible": true
  });
response = xos.pool_members.create({"talent_pool_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "level": "Preferred", "reason": "Repeated no-shows.", "review_on": "2026-10-08", "rehire_eligible": True})
xos pool-members create --data '{"talent_pool_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","level":"Preferred","reason":"Repeated no-shows.","review_on":"2026-10-08","rehire_eligible":true}'