Create location attribute

Creates a unique location attribute

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

code

string

Location attribute code

name

string

Location attribute name

description

string

Detailed description of the attribute

type

enum<string>

Data type of an attribute

Available options:

BOOLEAN,

INTEGER,

NUMBER,

STRING

required

boolean

Flag to define the attribute as mandatory while creating location. If it's configured as true, this attribute is mandatory while creating location.

Response

200 - application/json

id

string

Location attribute ID that is generated automatically for the location

code

string

Location attribute code

name

string

Location attribute name

description

string

Detailed description about attribute

type

enum<string>

Data type of an attribute

Available options:

BOOLEAN,

INTEGER,

NUMBER,

STRING

required

boolean

Flag to define the attribute as mandatory while creating location. If it's configured as true, this attribute is needed while creating location