Tags

Tag customers to better organize your data.

Retrieve a list of tags

Retrieve a list of tags.

SecuritySecretApiKey or JWT
Request
query Parameters
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).

Responses
200

A list of tags was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array
name
required
string <= 255 characters ^[@~\-\.\w\s]+$

The tag is unique name, which is case-insensitive.

type
required
string

The tag type. Tags of a specific type could only be used for the corresponding entity.

Enum: "customer" "kyc-document"
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/tags
Request samples
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'
Response samples
application/json
[
  • {
    }
]

Create a tag

Create a tag.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Tag resource.

name
required
string <= 255 characters ^[@~\-\.\w\s]+$

The tag is unique name, which is case-insensitive.

type
required
string

The tag type. Tags of a specific type could only be used for the corresponding entity.

Enum: "customer" "kyc-document"
Responses
201

Tag was created.

Response Schema: application/json
name
required
string <= 255 characters ^[@~\-\.\w\s]+$

The tag is unique name, which is case-insensitive.

type
required
string

The tag type. Tags of a specific type could only be used for the corresponding entity.

Enum: "customer" "kyc-document"
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

409

Conflict.

422

Invalid data was sent.

post/tags
Request samples
application/json
{
  • "name": "New",
  • "type": "customer"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "New",
  • "type": "customer",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Retrieve a tag

Retrieve a tag.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

Responses
200

Tag with specified name was retrieved successfully.

Response Schema: application/json
name
required
string <= 255 characters ^[@~\-\.\w\s]+$

The tag is unique name, which is case-insensitive.

type
required
string

The tag type. Tags of a specific type could only be used for the corresponding entity.

Enum: "customer" "kyc-document"
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/tags/{tag}
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "New",
  • "type": "customer",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Update a tag

Update a tag.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

Request Body schema: application/json

Tag resource.

name
required
string <= 255 characters ^[@~\-\.\w\s]+$

The tag is unique name, which is case-insensitive.

Responses
200

Tag was updated.

Response Schema: application/json
name
required
string <= 255 characters ^[@~\-\.\w\s]+$

The tag is unique name, which is case-insensitive.

type
required
string

The tag type. Tags of a specific type could only be used for the corresponding entity.

Enum: "customer" "kyc-document"
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

409

Conflict.

422

Invalid data was sent.

patch/tags/{tag}
Request samples
application/json
{
  • "name": "New",
  • "type": "customer"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "New",
  • "type": "customer",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Delete a tag

Delete a tag. It's an asynchronous operation.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

Responses
204

Tag was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

delete/tags/{tag}
Request samples
curl -i -X DELETE \
  'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Tag a list of customers

Tag a list of customers. If the customer from the list is already tagged it will be ignored. It's an asynchronous operation.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

Request Body schema: application/json
customerIds
required
Array of strings [ 1 .. 1000 ] items

The list of customer IDs.

Responses
204

Customers was tagged.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/tags/{tag}/customers
Request samples
application/json
{
  • "customerIds": [
    ]
}
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Untag a list of customers

Untag a list of customers. If the customer from the list is already untagged it will be ignored. It's an asynchronous operation.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

Request Body schema: application/json
customerIds
required
Array of strings [ 1 .. 1000 ] items

The list of customer IDs.

Responses
204

Customers was untagged.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

delete/tags/{tag}/customers
Request samples
application/json
{
  • "customerIds": [
    ]
}
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Tag a customer

Tag a customer.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

customerId
required
string <= 50 characters ^[@~\-\.\w]+$

The customer identifier string.

Responses
204

Customer was tagged.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

post/tags/{tag}/customers/{customerId}
Request samples
curl -i -X POST \
  'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}/customers/{customerId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Untag a customer

Untag a customer.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

customerId
required
string <= 50 characters ^[@~\-\.\w]+$

The customer identifier string.

Responses
204

Customer was untagged.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

delete/tags/{tag}/customers/{customerId}
Request samples
curl -i -X DELETE \
  'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}/customers/{customerId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Tag a list of kyc documents

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.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

Request Body schema: application/json
kycDocumentIds
required
Array of strings [ 1 .. 1000 ] items

The list of kyc document IDs.

Responses
204

KYC Documents were tagged.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/tags/{tag}/kyc-documents
Request samples
application/json
{
  • "kycDocumentIds": [
    ]
}
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Untag a list of kyc documents

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.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

Request Body schema: application/json
kycDocumentIds
required
Array of strings [ 1 .. 1000 ] items

The list of kyc document IDs.

Responses
204

KYC Documents were untagged.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

delete/tags/{tag}/kyc-documents
Request samples
application/json
{
  • "kycDocumentIds": [
    ]
}
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Tag a kyc document

Tag a kyc document.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

kycDocumentId
required
string <= 50 characters ^[@~\-\.\w]+$

The kyc document identifier string.

Responses
204

KYC Document was tagged.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

post/tags/{tag}/kyc-documents/{kycDocumentId}
Request samples
curl -i -X POST \
  'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}/kyc-documents/{kycDocumentId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Untag a kyc document

Untag a kyc document.

SecuritySecretApiKey or JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

The tag name.

kycDocumentId
required
string <= 50 characters ^[@~\-\.\w]+$

The kyc document identifier string.

Responses
204

KYC Document was untagged.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

delete/tags/{tag}/kyc-documents/{kycDocumentId}
Request samples
curl -i -X DELETE \
  'https://api-sandbox.rebilly.com/organizations/unknown/tags/{tag}/kyc-documents/{kycDocumentId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}