Retrieve a list of tags.
limit | integer [ 0 .. 1000 ] The collection items limit. |
offset | integer >= 0 The collection items offset. |
filter | string The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format. |
q | string The partial search of the text fields. |
sort | Array of strings The collection items sort field and order (prefix with "-" for descending sort). |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
id | string <= 50 characters The tag's identifier string. |
name required | string <= 255 characters ^[@~\-\.\w\s]+$ The tag is unique name, which is case-insensitive. |
createdTime | string <date-time> The tag's created time. |
updatedTime | string <date-time> The tag's updated time. |
Array of SelfLink (object) non-empty The links related to resource. |
curl -i -X GET \ 'https://api-sandbox.rebilly.com/tags?limit=0&offset=0&filter=string&q=string&sort=string' \ -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
[- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
]
Create a tag.
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Tag resource.
name required | string <= 255 characters ^[@~\-\.\w\s]+$ The tag is unique name, which is case-insensitive. |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
id | string <= 50 characters The tag's identifier string. |
name required | string <= 255 characters ^[@~\-\.\w\s]+$ The tag is unique name, which is case-insensitive. |
createdTime | string <date-time> The tag's created time. |
updatedTime | string <date-time> The tag's updated time. |
Array of SelfLink (object) non-empty The links related to resource. |
{- "name": "New"
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Retrieve a tag.
tag required | string^[@~\-\.\w\s]+$ The tag name. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
id | string <= 50 characters The tag's identifier string. |
name required | string <= 255 characters ^[@~\-\.\w\s]+$ The tag is unique name, which is case-insensitive. |
createdTime | string <date-time> The tag's created time. |
updatedTime | string <date-time> The tag's updated time. |
Array of SelfLink (object) non-empty The links related to resource. |
curl -i -X GET \ https://api-sandbox.rebilly.com/tags/:tag \ -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Update a tag.
tag required | string^[@~\-\.\w\s]+$ The tag name. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Tag resource.
name required | string <= 255 characters ^[@~\-\.\w\s]+$ The tag is unique name, which is case-insensitive. |
id | string <= 50 characters The tag's identifier string. |
name required | string <= 255 characters ^[@~\-\.\w\s]+$ The tag is unique name, which is case-insensitive. |
createdTime | string <date-time> The tag's created time. |
updatedTime | string <date-time> The tag's updated time. |
Array of SelfLink (object) non-empty The links related to resource. |
{- "name": "New"
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Delete a tag. It's an asynchronous operation.
tag required | string^[@~\-\.\w\s]+$ The tag name. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
curl -i -X DELETE \ https://api-sandbox.rebilly.com/tags/:tag \ -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Tag a list of customers. If the customer from the list is already tagged it will be ignored. It's an asynchronous operation.
tag required | string^[@~\-\.\w\s]+$ The tag name. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
customerIds required | Array of strings [ 1 .. 1000 ] items The list of customer IDs. |
{- "customerIds": [
- "string"
]
}
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Untag a list of customers. If the customer from the list is already untagged it will be ignored. It's an asynchronous operation.
tag required | string^[@~\-\.\w\s]+$ The tag name. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
customerIds required | Array of strings [ 1 .. 1000 ] items The list of customer IDs. |
{- "customerIds": [
- "string"
]
}
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Tag a customer.
tag required | string^[@~\-\.\w\s]+$ The tag name. |
customerId required | string <= 50 characters ^[@~\-\.\w]+$ The customer identifier string. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
curl -i -X POST \ https://api-sandbox.rebilly.com/tags/:tag/customers/:customerId \ -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Untag a customer.
tag required | string^[@~\-\.\w\s]+$ The tag name. |
customerId required | string <= 50 characters ^[@~\-\.\w]+$ The customer identifier string. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
curl -i -X DELETE \ https://api-sandbox.rebilly.com/tags/:tag/customers/:customerId \ -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}