--- title: "POST /objects/{object_name}/attributes" method: POST path: "/objects/{object_name}/attributes" tags: ["Object Attributes"] --- # POST /objects/{object_name}/attributes `POST /objects/{object_name}/attributes` ## Path parameters - `object_name` string, required ## Request body - union — Definition of an attribute on a Unify object. - object — Base properties that define an attribute on a Unify object. - `type` 'ADDRESS', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'BOOLEAN', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'COUNTRY', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'CURRENCY', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'DATE', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'DATETIME', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'DECIMAL', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'EMAIL_ADDRESS', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'INTEGER', required — The type of value this attribute can hold. - `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, nullable, 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. - UObjectsUMultiSelectAttribute — Base properties that define an attribute on a Unify object. - `type` 'MULTI_SELECT', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'PHONE_NUMBER', required — The type of value this attribute can hold. - `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, nullable, 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. - UObjectsUReferenceAttribute — Base properties that define an attribute on a Unify object. - `type` 'REFERENCE', required — The type of value this attribute can hold. - `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, nullable, 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. - UObjectsUSelectAttribute — Base properties that define an attribute on a Unify object. - `type` 'SELECT', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'TEXT', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'URL', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'UUID', required — The type of value this attribute can hold. - `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, nullable, 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 `201` Response for a successful create operation. - object — Response for a successful create operation. - `status` 'success', required - `data` union, required — Definition of an attribute on a Unify object. - object — Base properties that define an attribute on a Unify object. - `type` 'ADDRESS', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'BOOLEAN', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'COUNTRY', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'CURRENCY', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'DATE', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'DATETIME', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'DECIMAL', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'EMAIL_ADDRESS', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'INTEGER', required — The type of value this attribute can hold. - `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, nullable, 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. - UObjectsUMultiSelectAttribute — Base properties that define an attribute on a Unify object. - `type` 'MULTI_SELECT', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'PHONE_NUMBER', required — The type of value this attribute can hold. - `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, nullable, 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. - UObjectsUReferenceAttribute — Base properties that define an attribute on a Unify object. - `type` 'REFERENCE', required — The type of value this attribute can hold. - `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, nullable, 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. - UObjectsUSelectAttribute — Base properties that define an attribute on a Unify object. - `type` 'SELECT', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'TEXT', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'URL', required — The type of value this attribute can hold. - `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, nullable, 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. - object — Base properties that define an attribute on a Unify object. - `type` 'UUID', required — The type of value this attribute can hold. - `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, nullable, 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. ## Other responses - `400` — Response for any operation that results in a bad request error. - `401` — Response for any operation that results in an unauthorized error. - `404` — Response for any operation that results in a not found error. - `409` — Response for any operation that results in a conflict error. - `500` — Response for any operation that results in an internal server error. --- [API](https://skmtc.dev/unifygtm/apis/unify-analytics-api.md) · [All operations](https://skmtc.dev/unifygtm/apis/unify-analytics-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/unifygtm/unify-analytics-api/revisions/2f145e6f6d7e/schema)