Create Attribute

Authorizations

x-api-key · string · header · required

Path Parameters

object_name · string · required

Body

application/json

Option 1

Definition of an attribute on a Unify object. Base properties that define an attribute on a Unify object.

type · enum<string> · required

The type of value this attribute can hold. Supported object attribute value type.

Available options:

Address,

Boolean,

Country,

Currency,

Date,

DateTime,

Decimal,

EmailAddress,

Integer,

MultiSelect,

PhoneNumber,

Reference,

Select,

Text,

Url,

Uuid

api_name · string · required

This is the unique identifier for the attribute at the API level. It is unique within the object and cannot be changed.

display_name · string · required

This is the user-facing attribute name that will be shown within Unify. It is unique within the object and can be changed at any time.

description · string · required

This is a description of the attribute. It is not required but will be shown in the UI to help understand the purpose of the object. Typically, this should be a short sentence or two explaining the attribute.

is_required · boolean · required

Whether the attribute is required.

is_unique · boolean · required

Whether the attribute is unique.

Response

201

application/json

Response for a successful create operation.

status · enum<string> · required

Available options:

success

data · object · required

Definition of an attribute on a Unify object. Base properties that define an attribute on a Unify object.

Option 1

Show child attributes