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). |
A list of tags was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Unauthorized access, invalid credentials were used.
Access forbidden.
curl -i -X GET \ 'https://api-sandbox.rebilly.com/organizations/unknown/tags?limit=1000&offset=0&filter=string&q=string&sort=string' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
[- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "type": "customer",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
]
Create a tag.
Tag was created.
Unauthorized access, invalid credentials were used.
Access forbidden.
Conflict.
Invalid data was sent.
{- "name": "New",
- "type": "customer"
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "type": "customer",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Retrieve a tag.
Tag with specified name was retrieved successfully.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X GET \ 'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "type": "customer",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Update a tag.
Tag was updated.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Conflict.
Invalid data was sent.
{- "name": "New",
- "type": "customer"
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "type": "customer",
- "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 was deleted.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X DELETE \ 'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Tag a list of customers. If the customer from the list is already tagged it will be ignored. It's an asynchronous operation.
Customers was tagged.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "customerIds": [
- "string"
]
}
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Untag a list of customers. If the customer from the list is already untagged it will be ignored. It's an asynchronous operation.
Customers was untagged.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "customerIds": [
- "string"
]
}
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Tag a customer.
Customer was tagged.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X POST \ 'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}/customers/{customerId}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Untag a customer.
Customer was untagged.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X DELETE \ 'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}/customers/{customerId}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Tag a list of kyc documents. If the kyc document from the list is already tagged it will be ignored. It's an asynchronous operation.
KYC Documents were tagged.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "kycDocumentIds": [
- "string"
]
}
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Untag a list of kyc documents. If the kyc document from the list is already untagged it will be ignored. It's an asynchronous operation.
KYC Documents were untagged.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "kycDocumentIds": [
- "string"
]
}
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Tag a kyc document.
KYC Document was tagged.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X POST \ 'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}/kyc-documents/{kycDocumentId}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}
Untag a kyc document.
KYC Document was untagged.
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X DELETE \ 'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}/kyc-documents/{kycDocumentId}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{- "status": 401,
- "title": "string",
- "detail": "string",
- "instance": "string"
}