Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Path Parameters

object_name
string
required

Body

application/json

Definition of an attribute on a Unify object.

type
enum<string>
required

The type of value this attribute can hold.

Available options:
ADDRESS
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 | null
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

Response for a successful create operation.

Response for a successful create operation.

status
enum<string>
required
Available options:
success
data
object
required

Definition of an attribute on a Unify object.