Skip to content

Update a pool member

Opportunities module

PATCH/pool-members/{id}poolMembers.update

A pool member. Do Not Engage needs a reason and a review date and is never visible externally. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability opportunities.pool.write.
  • OAuth scopes: opportunities.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

poolMembers.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the pool member.

Request body: PoolMemberUpdate

poolMembers.update: PoolMemberUpdate
FieldTypeRequiredDescription
person_idstring (uuid) | nullNoIdentifier of the member person.
organization_idstring (uuid) | nullNoIdentifier of the member organization.
levelPoolLevelNoTalent 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"
reasonstring | nullNoReason, required for Do Not Engage.Constraints: length 1 to 20000
review_onstring (date) | nullNoReview date, required for Do Not Engage.
rehire_eligiblebooleanNoRehire eligibility.
{
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "reason": "Repeated no-shows.",
  "review_on": "2026-10-08",
  "rehire_eligible": true
}

Response 200: PoolMember

poolMembers.update: PoolMember
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the pool member.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
talent_pool_idstring (uuid)YesIdentifier of the pool.
person_idstring (uuid) | nullYesIdentifier of the member person.
organization_idstring (uuid) | nullYesIdentifier of the member organization.
levelPoolLevelYesTalent 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"
reasonstring | nullYesReason, required for Do Not Engage.Constraints: length 1 to 20000
review_onstring (date) | nullYesReview date, required for Do Not Engage.
rehire_eligiblebooleanYesRehire 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 PATCH "$XOS_BASE_URL/pool-members/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","reason":"Repeated no-shows.","review_on":"2026-10-08","rehire_eligible":true}'
const { data, etag } = await xos.poolMembers.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "reason": "Repeated no-shows.",
    "review_on": "2026-10-08",
    "rehire_eligible": true
  }, { ifMatch: etag });
response = xos.pool_members.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "reason": "Repeated no-shows.", "review_on": "2026-10-08", "rehire_eligible": True}, if_match=etag)
xos pool-members update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","reason":"Repeated no-shows.","review_on":"2026-10-08","rehire_eligible":true}' --if-match auto