Sign in
Data
Objects

post/data/v1/objects

Request body

provider'UNIFY' | 'CUSTOMER' required

Represents who created and manages an object in Unify.

In most ways, all objects within the Unify platform behave the same way regardless of whether they are defined by Unify or as custom objects by a plugin or user. This includes the ability to define custom attributes and access records via API.

However, there are some subtle distinctions that require differentiating between these classifications of objects. This enumeration is used to represent these distinctions.

api_namestring required

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

display_namestring required

This is the user-facing object name shown within Unify. It is not required to be unique within Unify and can be changed at any time.

descriptionstring nullable required

This is a description of the object. 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 object.

Response

Response for a successful create operation.

status'success' required

Changes

Changed in 2 of the 7 revisions of this API.33

  • 8f2318f5f13a32See the full diff
    • ▲

      request property description list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      the response property data/description became nullable for the status 201

      response-property-became-nullable

    • ▲

      removed 'unevaluatedProperties' constraint from the errors/items/allOf[subschema #1]/ response property for the status 400

      response-property-unevaluated-properties-removed

    • ○

      the request property description became nullable

      request-property-became-nullable

    • ○

      response property data/description list-of-types was narrowed by removing types null from media type application/json of response 201

      response-property-list-of-types-narrowed

  • 6c8df028bd7e1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog