Skip to content

Update a talent pool

Opportunities module

PATCH/talent-pools/{id}talentPools.update

A talent or vendor pool. 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

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

Request body: TalentPoolUpdate

talentPools.update: TalentPoolUpdate
FieldTypeRequiredDescription
namestringNoPool name.Constraints: length 1 to 300
{
  "name": "Preferred Riggers"
}

Response 200: TalentPool

talentPools.update: TalentPool
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the talent pool.
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.
namestringYesPool name.Constraints: length 1 to 300
pool_kind"Talent" | "Vendor"YesTalent (people) or Vendor (external accounts).
{
  "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",
  "name": "Preferred Riggers",
  "pool_kind": "Talent"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/talent-pools/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 '{"name":"Preferred Riggers"}'
const { data, etag } = await xos.talentPools.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Preferred Riggers"
  }, { ifMatch: etag });
response = xos.talent_pools.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Preferred Riggers"}, if_match=etag)
xos talent-pools update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Preferred Riggers"}' --if-match auto