Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Path Parameters

object_name
string
required

API name of the object.

Body

application/json

Definition of an attribute on a Unify object.

type
enum<string>
required

Type of value the attribute can hold. Cannot be changed after creation.

Available options:
ADDRESS
api_name
string
required

API name of the attribute. Unique within the object and cannot be changed.

display_name
string
required

Display name shown in Unify. Unique within the object and can be changed.

description
string | null
required

Description of the attribute shown in Unify.

is_required
boolean
required

Whether the attribute is required.

is_unique
boolean
required

Whether the attribute value must be unique across records. Unique attributes can be used to match records in find-unique and upsert requests.

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.