See what's new in the
Kick Changelog
Ctrlk
Go to Kick
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Transaction Rules

List, create, update, and delete the transaction rules of a workspace, and read a single rule.

Transaction rules categorize a workspace's transactions as Kick processes them, so all five endpoints are nested under the workspace uuid. Listing returns them in application order, and a rule you create lands in the workspace's default rule group.

A rule takes effect on future processing only. Creating one does not reprocess transactions already in the books, and deleting one leaves the values it already applied in place.

On update, conditions and actions are replaced as a whole when present, so send the full desired set rather than the pieces you want changed.

List transaction rules

get

Returns the workspace's transaction rules in application order. Results are paged with limit/offset.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
workspaceIdstring · uuidRequired
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault: 100
offsetinteger · nullableOptionalDefault: 0
Responses
200

200

application/json
get/platform/v1/workspaces/{workspaceId}/transaction-rules
GET /api/platform/v1/workspaces/{workspaceId}/transaction-rules HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "actions": [
        {
          "actionType": "account_id",
          "value": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "conditions": [
        {
          "conditionType": "description_is",
          "value": [
            "text"
          ]
        }
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isDisabled": true,
      "note": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "total": 1
  }
}

Create a transaction rule

post

Creates a rule in the workspace's default transaction rule group. The rule applies to future transaction processing; existing transactions are not re-processed.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
workspaceIdstring · uuidRequired
Header parameters
Idempotency-Keystring · min: 1 · max: 255Optional

A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with Idempotent-Replayed: true) instead of executing again.

Body
notestring · max: 5000 · nullableOptional
Responses
201

201

application/json
post/platform/v1/workspaces/{workspaceId}/transaction-rules
POST /api/platform/v1/workspaces/{workspaceId}/transaction-rules HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "actions": [
    {
      "actionType": "account_id",
      "value": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "conditions": [
    {
      "conditionType": "description_is",
      "value": [
        "text"
      ]
    }
  ],
  "note": "text"
}
{
  "rule": {
    "actions": [
      {
        "actionType": "account_id",
        "value": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "conditions": [
      {
        "conditionType": "description_is",
        "value": [
          "text"
        ]
      }
    ],
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isDisabled": true,
    "note": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
}

Retrieve a transaction rule

get

Returns a single transaction rule of the workspace. A rule outside the organization's book of business reads as not found.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
workspaceIdstring · uuidRequired
ruleIdstring · uuidRequired
Responses
200

200

application/json
get/platform/v1/workspaces/{workspaceId}/transaction-rules/{ruleId}
GET /api/platform/v1/workspaces/{workspaceId}/transaction-rules/{ruleId} HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rule": {
    "actions": [
      {
        "actionType": "account_id",
        "value": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "conditions": [
      {
        "conditionType": "description_is",
        "value": [
          "text"
        ]
      }
    ],
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isDisabled": true,
    "note": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
}

Update a transaction rule

patch

Updates a rule. conditions and actions replace the existing sets when provided.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
workspaceIdstring · uuidRequired
ruleIdstring · uuidRequired
Header parameters
Idempotency-Keystring · min: 1 · max: 255Optional

A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with Idempotent-Replayed: true) instead of executing again.

Body
isDisabledbooleanOptional

Set true to disable the rule without deleting it.

notestring · max: 5000 · nullableOptional

Internal rule note. Use null to clear.

Responses
200

200

application/json
patch/platform/v1/workspaces/{workspaceId}/transaction-rules/{ruleId}
PATCH /api/platform/v1/workspaces/{workspaceId}/transaction-rules/{ruleId} HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "actions": [
    {
      "actionType": "account_id",
      "value": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "conditions": [
    {
      "conditionType": "description_is",
      "value": [
        "text"
      ]
    }
  ],
  "isDisabled": true,
  "note": "text"
}
{
  "rule": {
    "actions": [
      {
        "actionType": "account_id",
        "value": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "conditions": [
      {
        "conditionType": "description_is",
        "value": [
          "text"
        ]
      }
    ],
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isDisabled": true,
    "note": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
}

Delete a transaction rule

delete

Deletes a rule. Transactions it already categorized keep their values.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
workspaceIdstring · uuidRequired
ruleIdstring · uuidRequired
Header parameters
Idempotency-Keystring · min: 1 · max: 255Optional

A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with Idempotent-Replayed: true) instead of executing again.

Responses
200

200

No content
delete/platform/v1/workspaces/{workspaceId}/transaction-rules/{ruleId}
DELETE /api/platform/v1/workspaces/{workspaceId}/transaction-rules/{ruleId} HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousTransactions
NextClasses

Last updated

Was this helpful?