Create Tag

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tags/tenant/tenant-id/{tenantId}/tags

Path Params

tenantId

string

required

Tenant identifier.

Body Params

name

string

required

Name (lowercase; spacing and punctuation will be replaced by "-").

level

string

enum

required

Level.

Allowed:

displayName

array of objects

required

The value to display for a given locale. displayValue entities allow for built-in translation. Values can be set depending on the possible locales, so that the associated information can be displayed in the appropriate language for a locale.

displayName*

childOf

string

Parent tag name (only for "tag" and "subtag" levels).

brandCode

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

Response

200

The given Tag.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!