API Reference

Create Custom Record types

post
https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id//record-types

Creates a custom Hanger (recordType)/

Path Params
string
required

Tenant identifier.

Body Params
string
required

Hanger (recordType) name.

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".

sidedrawerTypes
array of objects

Drawer (sidedrawer) type (individual as default).

sidedrawerTypes
string
required

Hanger (recordType) image URL.

displayValue
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.

displayValue*
number

Number of the position of this entity when the entities are sorted in a list.

string

Drawer (sidedrawer) type (individual as default).

string

Drawer (sidedrawer) type if sidedrawerType = "other".

Response

Updated 9 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?