logo

Retrieve a tags rule

Retrieves a tags rule with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Tags rule retrieved.

Response Schema: application/json
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.

id
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

Related resource links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/tags-rules/{id}
Request samples 
Response samples 
application/json
{
  • "id": "tag_rule_0YVCEE5APAD7V84MK3P9CCJVYY",
  • "name": "string",
  • "eventType": "aml-list-possibly-matched",
  • "filter": "string",
  • "addTags": [
    ],
  • "removeTags": [
    ],
  • "status": "active",
  • "_links": [
    ]
}
➔ Next to Create a tags rule with specified ID