/
Create a tag

Create a tag

Request

Creates a tag.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Tag resource.

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

Unique name for the tag. Tag names are not case-sensitive.

Example:"New"
typestringrequired

Type of tag. Tags of a specific type can only be assigned to corresponding entity types. For example, you can only use customer tags on customers.

Enum:"customer""kyc-document""aml-check"
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/tags \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "name": "New",
    "type": "customer"
  }'

Responses

Tag created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 characters(ResourceId)read-only

ID of the tag.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
namestring, <= 255 characters^[@~\-\.\w\s+]+$required

Unique name for the tag. Tag names are not case-sensitive.

Example:"New"
typestringrequired

Type of tag. Tags of a specific type can only be assigned to corresponding entity types. For example, you can only use customer tags on customers.

Enum:"customer""kyc-document""aml-check"
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": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "name": "New",
  "type": "customer",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}