Skip to main content

Authorizations

X-API-Key
string
header
required

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

Headers

Idempotency-Key
string
required

Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.

Required string length: 1 - 255

Path Parameters

customerId
string
required
ruleId
string
required

Body

application/json
status
enum<string>

Pause or resume the rule. Archiving is terminal and only happens through DELETE.

Available options:
active,
paused
label
string
Maximum string length: 255
metadata
object

Response

Rule updated

data
object
required