/
Retrieve a tags rule

Retrieve a tags rule

Request

Retrieves a tags rule with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/tags-rules/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Tags rule retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the rule.

Example:"tag_rule_0YVCEE5APAD7V84MK3P9CCJVYY"
namestringrequired

Name of the rule.

eventTypestring(GlobalEventType)required

Type of event.

Enum:"aml-list-possibly-matched""application-instance-disabled""application-instance-enabled""autodeposit-lookup-performed""balance-transaction-settled""coupon-application-removed""coupon-applied""coupon-expiration-modified""coupon-expired""coupon-issued"
filterstring 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.

addTagsArray of strings, [ 0 .. 1000 ] itemsrequired

List of tags to add to the customer.

removeTagsArray of strings, [ 0 .. 1000 ] itemsrequired

List of tags to remove for the customer.

statusstring

Status of the rule.

Default:"active"
Enum:"active""inactive"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "tag_rule_0YVCEE5APAD7V84MK3P9CCJVYY",
  "name": "string",
  "eventType": "aml-list-possibly-matched",
  "filter": "string",
  "addTags": [
    "string"
  ],
  "removeTags": [
    "string"
  ],
  "status": "active",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}