Unify Object Attributes API
The Object Attributes API from Unify — 2 operation(s) for object attributes.
OpenAPI Specification
openapi: 3.1.0
info:
title: Unify Analytics Events Object Attributes API
summary: Send website and product analytics data into 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.unifyintent.com/analytics/v1
variables: {}
security:
- BasicAuth: []
tags:
- name: Object Attributes
paths:
/objects/{object_name}/attributes:
get:
operationId: list_object_attributes
parameters:
- name: object_name
in: path
required: true
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
post:
operationId: create_object_attribute
parameters:
- name: object_name
in: path
required: true
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.
'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'
/objects/{object_name}/attributes/{attribute_name}:
get:
operationId: get_object_attribute
parameters:
- name: object_name
in: path
required: true
schema:
type: string
- name: attribute_name
in: path
required: true
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
patch:
operationId: update_object_attribute
parameters:
- name: object_name
in: path
required: true
schema:
type: string
- name: attribute_name
in: path
required: true
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.
'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'
delete:
operationId: delete_object_attribute
parameters:
- name: object_name
in: path
required: true
schema:
type: string
- name: attribute_name
in: path
required: true
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.
'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
components:
schemas:
UObjects.UAttributeUpdate:
anyOf:
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- $ref: '#/components/schemas/UObjects.UMultiSelectAttributeUpdate'
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- $ref: '#/components/schemas/UObjects.UReferenceAttributeUpdate'
- $ref: '#/components/schemas/UObjects.USelectAttributeUpdate'
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
description: Definition of an attribute on a Unify object.
UResponses.BadRequestError:
type: object
required:
- code
properties:
code:
type: string
path:
type: array
items:
anyOf:
- type: string
- type: integer
object_api_name:
type: string
attribute_api_name:
type: string
allOf:
- type: object
unevaluatedProperties: {}
description: Validation error detail returned for bad request responses.
UObjects.UMultiSelectAttributeUpdate:
type: object
required:
- options
properties:
options:
type: array
items:
$ref: '#/components/schemas/UObjects.UAttributeOptionUpdateItem'
description: The list of options for the attribute.
allOf:
- type: object
required:
- display_name
- description
properties:
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:
anyOf:
- type: string
- type: 'null'
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.'
description: Base properties that define an attribute on a Unify object.
description: Definition of a "multi-select" attribute on a Unify object.
UObjects.USelectAttribute:
type: object
required:
- options
properties:
options:
type: array
items:
$ref: '#/components/schemas/UObjects.UAttributeOption'
description: The list of options for the attribute.
allOf:
- type: object
required:
- type
- api_name
- display_name
- description
- is_required
- is_unique
properties:
type:
type: string
enum:
- SELECT
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:
anyOf:
- type: string
- type: 'null'
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 att
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/openapi/unify-object-attributes-api-openapi.yml