Unify Object Attributes API

openapi: 3.0.0
info:
  title: Unify Data Object Attributes API
  summary: Interact with objects, attributes, and records within the Unify platform.
  version: '1'
  termsOfService: https://www.unifygtm.com/legal/terms-and-conditions
  contact:
    name: Unify Support
    url: https://www.unifygtm.com/support
    email: support@unifygtm.com
servers:
- url: https://api.unifygtm.com
  variables: {}
security:
- ApiKeyAuth: []
tags:
- name: Object Attributes
paths:
  /data/v1/objects/{object_name}/attributes:
    get:
      operationId: list_object_attributes
      description: 'List the attributes defined on an object. Attributes are the typed

        fields that records of the object hold values for, identified by API

        name.'
      parameters:
      - name: object_name
        in: path
        required: true
        description: API name of the object.
        schema:
          type: string
      responses:
        '200':
          description: Response for a successful list operation.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - data
                properties:
                  status:
                    type: string
                    enum:
                    - success
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UObjects.UAttribute'
                description: Response for a successful list operation.
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '404':
          description: Response for any operation that results in a not found error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - object_not_found
                  message:
                    type: string
                description: Response for any operation that results in a not found error.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Object Attributes
      x-mcp-tool:
        readOnlyHint: true
        openWorldHint: false
    post:
      operationId: create_object_attribute
      description: 'Add an attribute to an object. The attribute''s value type is fixed at

        creation; `SELECT` / `MULTI_SELECT` attributes take a list of options,

        and `REFERENCE` attributes link to records of a related object. Unique

        attributes can be used to match records in find-unique and upsert

        requests.'
      parameters:
      - name: object_name
        in: path
        required: true
        description: API name of the object.
        schema:
          type: string
      responses:
        '201':
          description: Response for a successful create operation.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - data
                properties:
                  status:
                    type: string
                    enum:
                    - success
                  data:
                    $ref: '#/components/schemas/UObjects.UAttribute'
                description: Response for a successful create operation.
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                    - attribute_reference_object_not_found
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '403':
          description: Response for any operation that results in a forbidden error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - forbidden
                  message:
                    type: string
                description: Response for any operation that results in a forbidden error.
        '404':
          description: Response for any operation that results in a not found error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - object_not_found
                  message:
                    type: string
                description: Response for any operation that results in a not found error.
        '409':
          description: Response for any operation that results in a conflict error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - attribute_conflict
                  message:
                    type: string
                description: Response for any operation that results in a conflict error.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Object Attributes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UObjects.UAttribute'
      x-mcp-tool:
        destructiveHint: false
        openWorldHint: false
  /data/v1/objects/{object_name}/attributes/{attribute_name}:
    get:
      operationId: get_object_attribute
      description: Get a single attribute on an object by its API name.
      parameters:
      - name: object_name
        in: path
        required: true
        description: API name of the object.
        schema:
          type: string
      - name: attribute_name
        in: path
        required: true
        description: API name of the attribute.
        schema:
          type: string
      responses:
        '200':
          description: Response for a successful get operation.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - data
                properties:
                  status:
                    type: string
                    enum:
                    - success
                  data:
                    $ref: '#/components/schemas/UObjects.UAttribute'
                description: Response for a successful get operation.
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '404':
          description: Response for any operation that results in a not found error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - object_not_found
                    - attribute_not_found
                  message:
                    type: string
                description: Response for any operation that results in a not found error.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Object Attributes
      x-mcp-tool:
        readOnlyHint: true
        openWorldHint: false
    patch:
      operationId: update_object_attribute
      description: 'Update an attribute''s mutable fields (e.g. `display_name`,

        `description`). The value type and API name are fixed at creation, and a

        reference attribute''s cardinality cannot be downgraded from `MANY` to

        `ONE`.'
      parameters:
      - name: object_name
        in: path
        required: true
        description: API name of the object.
        schema:
          type: string
      - name: attribute_name
        in: path
        required: true
        description: API name of the attribute.
        schema:
          type: string
      responses:
        '200':
          description: Response for a successful update operation.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - data
                properties:
                  status:
                    type: string
                    enum:
                    - success
                  data:
                    $ref: '#/components/schemas/UObjects.UAttribute'
                description: Response for a successful update operation.
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                    - invalid_request_for_value_type
                    - one_to_one_references_not_supported
                    - reference_cardinality_downgrade_not_supported
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '403':
          description: Response for any operation that results in a forbidden error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - forbidden
                  message:
                    type: string
                description: Response for any operation that results in a forbidden error.
        '404':
          description: Response for any operation that results in a not found error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - object_not_found
                    - attribute_not_found
                  message:
                    type: string
                description: Response for any operation that results in a not found error.
        '409':
          description: Response for any operation that results in a conflict error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - related_attribute_conflict
                  message:
                    type: string
                description: Response for any operation that results in a conflict error.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Object Attributes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UObjects.UAttributeUpdate'
      x-mcp-tool:
        idempotentHint: true
        openWorldHint: false
    delete:
      operationId: delete_object_attribute
      description: Delete an attribute from an object by its API name.
      parameters:
      - name: object_name
        in: path
        required: true
        description: API name of the object.
        schema:
          type: string
      - name: attribute_name
        in: path
        required: true
        description: API name of the attribute.
        schema:
          type: string
      responses:
        '200':
          description: Response for a successful delete operation.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - success
                description: Response for a successful delete operation.
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '403':
          description: Response for any operation that results in a forbidden error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - forbidden
                  message:
                    type: string
                description: Response for any operation that results in a forbidden error.
        '404':
          description: Response for any operation that results in a not found error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - object_not_found
                    - attribute_not_found
                  message:
                    type: string
                description: Response for any operation that results in a not found error.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Object Attributes
      x-mcp-tool:
        idempotentHint: true
        openWorldHint: false
components:
  schemas:
    UObjects.UAttribute:
      anyOf:
      - type: object
        required:
        - type
        - api_name
        - display_name
        - description
        - is_required
        - is_unique
        properties:
          type:
            type: string
            enum:
            - ADDRESS
            description: The type of value this attribute can hold.
          api_name:
            type: string
            description: 'This is the unique identifier for the attribute at the API level. It is

              unique within the object and cannot be changed.'
          display_name:
            type: string
            description: '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:
            type: string
            nullable: true
            description: '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:
            type: boolean
            description: Whether the attribute is required.
          is_unique:
            type: boolean
            description: Whether the attribute is unique.
        description: Base properties that define an attribute on a Unify object.
      - type: object
        required:
        - type
        - api_name
        - display_name
        - description
        - is_required
        - is_unique
        properties:
          type:
            type: string
            enum:
            - BOOLEAN
            description: The type of value this attribute can hold.
          api_name:
            type: string
            description: 'This is the unique identifier for the attribute at the API level. It is

              unique within the object and cannot be changed.'
          display_name:
            type: string
            description: '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:
            type: string
            nullable: true
            description: '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:
            type: boolean
            description: Whether the attribute is required.
          is_unique:
            type: boolean
            description: Whether the attribute is unique.
        description: Base properties that define an attribute on a Unify object.
      - type: object
        required:
        - type
        - api_name
        - display_name
        - description
        - is_required
        - is_unique
        properties:
          type:
            type: string
            enum:
            - COUNTRY
            description: The type of value this attribute can hold.
          api_name:
            type: string
            description: 'This is the unique identifier for the attribute at the API level. It is

              unique within the object and cannot be changed.'
          display_name:
            type: string
            description: '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:
            type: string
            nullable: true
            description: '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:
            type: boolean
            description: Whether the attribute is required.
          is_unique:
            type: boolean
            description: Whether the attribute is unique.
        description: Base properties that define an attribute on a Unify object.
      - type: object
        required:
        - type
        - api_name
        - display_name
        - description
        - is_required
        - is_unique
        properties:
          type:
            type: string
            enum:
            - CURRENCY
            description: The type of value this attribute can hold.
          api_name:
            type: string
            description: 'This is the unique identifier for the attribute at the API level. It is

              unique within the object and cannot be changed.'
          display_name:
            type: string
            description: '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:
            type: string
            nullable: true
            description: '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:
            type: boolean
            description: Whether the attribute is required.
          is_unique:
            type: boolean
            description: Whether the attribute is unique.
        description: Base properties that define an attribute on a Unify object.
      - type: object
        required:
        - type
        - api_name
        - display_name
        - description
        - is_required
        - is_unique
        properties:
          type:
            type: string
            enum:
            - DATE
            description: The type of value this attribute can hold.
          api_name:
            type: string
            description: 'This is the unique identifier for the attribute at the API level. It is

              unique within the object and cannot be changed.'
          display_name:
            type: string
            description: '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:
            type: string
            nullable: true
            description: '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:
            type: boolean
            description: Whether the attribute is required.
          is_unique:
            type: boolean
            description: Whether the attribute is unique.
        description: Base properties that define an attribute on a Unify object.
      - type: object
        required:
        - type
        - api_name
        - display_name
        - description
        - is_required
        - is_unique
        properties:
          type:
            type: string
            enum:
            - DATETIME
            description: The type of value this attribute can hold.
          api_name:
            type: string
            description: 'This is the unique identifier for the attribute at the API level. It is

              unique within the object and cannot be changed.'
          display_name:
            type: string
            description: '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:
            type: string
            nullable: true
            description: '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:
            type: boolean
            description: Whether the attribute is required.
          is_unique:
            type: boolean
            description: Whether the attribute is unique.
        description: Base properties that define an attribute on a Unify object.
      - type: object
        required:
        - type
        - api_name
        - display_name
        - description
        - is_required
        - is_unique
        properties:
          type:
            type: string
            enum:
            - DECIMAL
            description: The type of value this attribute can hold.
          api_name:
            type: string
            description: 'This is the unique identifier for the attribute at the API level. It is

              unique within the object and cannot be changed.'
          display_name:
            type: string
            description: '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:
            type: string
            nullable: true
            description: '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:
            type: boolean
            description: Whether the attribute is required.
          is_unique:
            type: boolean
            description: Whether the attribute is unique.
        description: Base properties that define an attribute on a Unify object.
      - type: object
        required:
        - type
        - api_name
        - display_name
        - description
        - is_required
        - is_unique
        properties:
          type:
            type: string
            enum:
            - EMAIL_ADDRESS
            description: The type of value this attribute can hold.
          api_name:
            type: string
            description: 'This is the unique identifier for the attribute at the API level. It is

              unique within the object and cann

# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/openapi/unify-object-attributes-api-openapi.yml