Skip to content

Update a saved search

Gateway module

PATCH/saved-searches/{id}savedSearches.update

A saved marketplace search that sends alerts. 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 me.profile.write.
  • OAuth scopes: me.
  • 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

savedSearches.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the saved search.

Request body: SavedSearchUpdate

savedSearches.update: SavedSearchUpdate
FieldTypeRequiredDescription
namestringNoSearch name.Constraints: length 1 to 300
alerts_enabledbooleanNoWhether alerts are sent by email and push.
role_typeExternalRoleType | nullNo
role_codeRoleCode | nullNo
cat_uridUridAtAnyGrain | nullNo
jurisdiction_idJurisdictionId | nullNo
starts_afterstring (date) | nullNoEarliest start date.
ends_beforestring (date) | nullNoLatest end date.
min_rate_minorinteger (int64) | nullNoMinimum posted pay. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullNoISO 4217 currency of the minimum pay.Constraints: pattern ^[A-Z]{3}$
{
  "name": "Miami Rigging Calls",
  "alerts_enabled": true,
  "starts_after": "2026-10-08",
  "ends_before": "2026-10-08",
  "min_rate_minor": 3500,
  "currency_code": "USD"
}

Response 200: SavedSearch

savedSearches.update: SavedSearch
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the saved search.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
person_idstring (uuid)YesIdentifier of the owner.
namestringYesSearch name.Constraints: length 1 to 300
alerts_enabledbooleanYesWhether alerts are sent by email and push.
role_typeExternalRoleType | nullYes
role_codeRoleCode | nullYes
cat_uridUridAtAnyGrain | nullYes
jurisdiction_idJurisdictionId | nullYes
starts_afterstring (date) | nullYesEarliest start date.
ends_beforestring (date) | nullYesLatest end date.
min_rate_minorinteger (int64) | nullYesMinimum posted pay. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullYesISO 4217 currency of the minimum pay.Constraints: pattern ^[A-Z]{3}$
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Miami Rigging Calls",
  "alerts_enabled": true,
  "role_type": "Crew",
  "role_code": "5000.50.01",
  "cat_urid": "4000.01",
  "jurisdiction_id": "US-FL",
  "starts_after": "2026-10-08",
  "ends_before": "2026-10-08",
  "min_rate_minor": 3500,
  "currency_code": "USD"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/saved-searches/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":"Miami Rigging Calls","alerts_enabled":true,"starts_after":"2026-10-08","ends_before":"2026-10-08","min_rate_minor":3500,"currency_code":"USD"}'
const { data, etag } = await xos.savedSearches.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Miami Rigging Calls",
    "alerts_enabled": true,
    "starts_after": "2026-10-08",
    "ends_before": "2026-10-08",
    "min_rate_minor": 3500,
    "currency_code": "USD"
  }, { ifMatch: etag });
response = xos.saved_searches.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Miami Rigging Calls", "alerts_enabled": True, "starts_after": "2026-10-08", "ends_before": "2026-10-08", "min_rate_minor": 3500, "currency_code": "USD"}, if_match=etag)
xos saved-searches update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Miami Rigging Calls","alerts_enabled":true,"starts_after":"2026-10-08","ends_before":"2026-10-08","min_rate_minor":3500,"currency_code":"USD"}' --if-match auto