Create an Attribute

post

https://example.com/integration-tenants/api/v1/attributes

Note that Basic Authentication is required for all requests
as such, make sure to provide the Authorization header with a valid value.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

length between 1 and 36

^[a-zA-Z0-9_-]*$

Defaults to the-attribute-id

namePrimary

string

required

length between 0 and 256

nameSecondary

string | null

descriptionPrimary

string

required

length between 0 and 256

descriptionSecondary

string | null

hexColor

string | null

^#([0-9A-Fa-f]{3,4}|[0-9A-Fa-f]{6})$

Defaults to #000000

attributeType

int32

enum

required

[0 - 'Order', 1 - 'Driver', 2 - 'OrderAndDriver']

Allowed:

dispatchOption

int32

enum

[0 - 'Prevent', 1 - 'Warning', 2 - 'Allow', 3 - 'PreventIfBothHave', 4 - 'WarningIfBothHave']

Allowed:

isVisibleForSelfServe

boolean

isAvailableForAccounts

boolean

isAvailableForContacts

boolean

isAvailableForOrders

boolean

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200

Attribute created successfully

400

Request has missing/invalid values

Language

Credentials

Loading…

Response

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