SequenceSequence
Rules
Coming Soon — This endpoint is planned for a future release and is not yet available.
DELETE/rules/{id}

Soft-deletes the rule. The rule is deactivated and no longer visible in the Sequence app, but is not permanently removed from the system.

AuthorizationClick to expand
ApiKeyAuth
Authorization<token>

Format: ApiKey <key>. Keys are scoped to an organization and carry explicit permissions.

Each key holds a list of permission entries. An entry specifies a scope and a resources constraint. A request returns 403 if the key lacks the required scope, or if the requested resource is outside the key's allowed list.

ScopeResourcesGrants access to
LIST_ACCOUNTSnoneList all accounts in the organization
READ_ACCOUNTSaccount IDs or *Full account details and balance for a specific account
LIST_RULESnoneList all rules in the organization
READ_RULESrule IDs or *Full rule details (steps, conditions, actions) for a specific rule
TRIGGER_RULESrule IDs or *Triggering rule executions
READ_RULE_EXECUTIONSrule IDs or *Rule execution history - rule_id filter required
READ_TRANSFERSaccount IDs or *Transfer history - account_id filter required
MANUAL_TRANSFERlist of { source, target, max_amount? } setsCreating manual transfers
READ_CARDSaccount IDs or *Cards and card transactions - account_id filter required

In: header

Path Parameters

id*string

The rule ID.

Header Parameters

Idempotency-Key?string

A client-generated unique key to ensure idempotent processing. Requests with the same key within 24 hours return the original response without re-executing the operation. Recommended format: UUID v4.

X-Request-ID?string

A client-provided request identifier echoed back in the response `X-Request-ID` header and `request_id` body field. If omitted, the server generates one.

Response Body

application/json

application/json

application/json

curl -X DELETE "https://api.getsequence.io/api/v1/rules/string"
Empty
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required permission."
  }
}
{
  "error": {
    "code": "resource_not_found",
    "message": "Rule with id 'rule_123' was not found."
  }
}

Create a rule POSTv2

Creates a new rule. The rule is created in a disabled state and must be reviewed and set to `enabled` by a human in the Sequence app before it can be triggered.

Update a rule PUTv2

Fully replaces the rule configuration. All required fields must be provided. If the rule's status is `enabled`, the update will set it to `disabled` and require a human to review and re-enable it in the Sequence app before it can be triggered again.