Create a pool member
Opportunities module
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.
- Requires the capability opportunities.pool.write.
- OAuth scopes: opportunities.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: PoolMemberCreate
| Field | Type | Required | Description |
|---|---|---|---|
| talent_pool_id | string (uuid) | Yes | Identifier of the pool. |
| person_id | string (uuid) | null | No | Identifier of the member person. |
| organization_id | string (uuid) | null | No | Identifier of the member organization. |
| level | PoolLevel | Yes | Talent or vendor pool level. Do Not Engage is internal only and needs a reason and review date.Constraints: one of "Preferred", "Approved", "Do Not Engage" |
| reason | string | null | No | Reason, required for Do Not Engage.Constraints: length 1 to 20000 |
| review_on | string (date) | null | No | Review date, required for Do Not Engage. |
| rehire_eligible | boolean | Yes | 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
}Response 201: PoolMember
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the pool member. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| talent_pool_id | string (uuid) | Yes | Identifier of the pool. |
| person_id | string (uuid) | null | Yes | Identifier of the member person. |
| organization_id | string (uuid) | null | Yes | Identifier of the member organization. |
| level | PoolLevel | Yes | Talent or vendor pool level. Do Not Engage is internal only and needs a reason and review date.Constraints: one of "Preferred", "Approved", "Do Not Engage" |
| reason | string | null | Yes | Reason, required for Do Not Engage.Constraints: length 1 to 20000 |
| review_on | string (date) | null | Yes | Review date, required for Do Not Engage. |
| rehire_eligible | boolean | Yes | 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
}Code samples
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}'