Rebilly API Docs

Retrieve tags rules list

Retrieves a list of tags rules.

SecuritySecretApiKey or JWT

Request

query Parameters

limit	integer [ 0 .. 1000 ] Limits the number of collection items to be returned.
offset	integer >= 0 Specifies the starting point within the collection of items to be returned.
sort	Array of strings Sorts and orders the collection of items. To sort in descending order, prefix with `-`.
filter	string Filters the collection items. This field requires a special format. Use `,` for multiple allowed values. Use `;` for multiple fields. For more information, see Using filter with collections.
q	string Use this field to perform a partial search of text fields.

Responses

200

List of tags rules retrieved.

Response Headers
Pagination-Total	integer Total number of items. Example: 332
Pagination-Limit	integer Maximum number of items per page. Example: 100
Pagination-Offset	integer Specifies the starting point within the collection of resource results. For example, a request with `limit=20` retrieves and displays the first 20 results on a page. A following request with `limit=20` and `offset=20`, retrieves the next page of 20 results. Example: 2

Response Schema: application/json

Array

name

required

string

Name of the rule.

eventType

required

string

Type of event.

Enum: "aml-list-possibly-matched" "application-instance-disabled" "application-instance-enabled" "balance-transaction-settled" "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" "credit-memo-voided" "customer-created" … 77 more

addTags

required

Array of strings [ 0 .. 1000 ] items

List of tags to add to the customer.

removeTags

required

Array of strings [ 0 .. 1000 ] items

List of tags to remove for the customer.

string <= 50 characters

ID of the rule.

filter

string or null

Filter that determines whether to tag or untag. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filters.

status

string

Default: "active"

Status of the rule.

Enum: "active" "inactive"

Array of objects