Update a Smart List

Partially updates one or more supported Smart List settings and returns the settled resource.

Authentication

AuthorizationBearer

Workspace API key created in Sailor Settings > Integrations > API access.

Path parameters

smartListIdstringRequiredformat: "uuid"
Smart List identifier returned by the create or list operation.

Headers

Idempotency-KeystringRequired8-255 characters
Unique retry key retained for 86400 seconds. Reusing it with different request data is rejected.

Request

This endpoint expects an object.
namestringOptional1-120 characters
descriptionstring or nullOptional<=2000 characters
priorityenumOptional
Allowed values:
max_attempts_per_dayinteger or nullOptional0-100
max_attempts_totalinteger or nullOptional0-1000
min_retry_secondsintegerOptional0-31622399
dial_timeout_secondsintegerOptional15-60
next_list_idstring or nullOptionalformat: "uuid"

Response headers

X-Request-IdstringOptional
Stable request identifier for support and observability.
RateLimit-PolicystringOptional
Versioned structured quota policy. The syntax follows IETF RateLimit draft 11 and may evolve before standardization.
RateLimitstringOptional
Current structured quota state for the authenticated credential.
Idempotent-ReplayedstringOptional
True when this exact response was replayed from a completed idempotency record.

Response

Smart List updated.
oktrue
smart_listobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error