Create a saved search

Módulo Gateway

POST/saved-searchessavedSearches.create

A saved marketplace search that sends alerts. Creates a saved search. 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 me.profile.write.
Alcances de OAuth: me.
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: SavedSearchCreate

savedSearches.create: SavedSearchCreate
Campo	Tipo	Obligatorio	Descripción
person_id	string (uuid)	Sí	Identifier of the owner.
name	string	Sí	Search name.Restricciones: length 1 to 300
alerts_enabled	boolean	No	Whether alerts are sent by email and push.
role_type	ExternalRoleType \| null	No
role_code	RoleCode \| null	No
cat_urid	UridAtAnyGrain \| null	No
jurisdiction_id	JurisdictionId \| null	No
starts_after	string (date) \| null	No	Earliest start date.
ends_before	string (date) \| null	No	Latest end date.
min_rate_minor	integer (int64) \| null	No	Minimum posted pay. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	No	ISO 4217 currency of the minimum pay.Restricciones: pattern ^[A-Z]{3}$

{
  "person_id": "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"
}

Respuesta 201: SavedSearch

savedSearches.create: SavedSearch
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the saved search.
created_at	string (date-time)	Sí	When the row was created.
updated_at	string (date-time)	Sí	When the row was last updated.
person_id	string (uuid)	Sí	Identifier of the owner.
name	string	Sí	Search name.Restricciones: length 1 to 300
alerts_enabled	boolean	Sí	Whether alerts are sent by email and push.
role_type	ExternalRoleType \| null	Sí
role_code	RoleCode \| null	Sí
cat_urid	UridAtAnyGrain \| null	Sí
jurisdiction_id	JurisdictionId \| null	Sí
starts_after	string (date) \| null	Sí	Earliest start date.
ends_before	string (date) \| null	Sí	Latest end date.
min_rate_minor	integer (int64) \| null	Sí	Minimum posted pay. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	Sí	ISO 4217 currency of the minimum pay.Restricciones: 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"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/saved-searches" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"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"}'

const { data } = await xos.savedSearches.create({
    "person_id": "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"
  });

response = xos.saved_searches.create({"person_id": "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"})

xos saved-searches create --data '{"person_id":"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"}'