{ "openapi": "3.0.0", "info": { "title": "Unify Data 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" } }, "tags": [ { "name": "Data" }, { "name": "Objects" }, { "name": "Object Attributes" }, { "name": "Object Attribute Options" }, { "name": "Object Records" } ], "paths": { "/data/v1/objects": { "get": { "operationId": "list_objects", "parameters": [], "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.UObject" } } }, "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." } } } }, "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": [ "Data", "Objects" ] }, "post": { "operationId": "create_object", "parameters": [], "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.UObject" } }, "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" ] }, "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." } } } }, "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": [ "object_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": [ "Data", "Objects" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UObjects.UObject" } } } } } }, "/data/v1/objects/{object_name}": { "get": { "operationId": "get_object", "parameters": [ { "name": "object_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.UObject" } }, "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" ] }, "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": [ "Data", "Objects" ] }, "patch": { "operationId": "update_object", "parameters": [ { "name": "object_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.UObject" } }, "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" ] }, "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": [ "object_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": [ "Data", "Objects" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UObjects.UObjectUpdate" } } } } }, "delete": { "operationId": "delete_object", "parameters": [ { "name": "object_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." } } } }, "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." } } } }, "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": [ "Data", "Objects" ] } }, "/data/v1/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": [ "Data", "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": [ "Data", "Object Attributes" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UObjects.UAttribute" } } } } } }, "/data/v1/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": [ "Data", "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": [ "Data", "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": [ "Data", "Object Attributes" ] } }, "/data/v1/objects/{object_name}/attributes/{attribute_name}/options": { "get": { "operationId": "list_object_attribute_options", "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 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.UAttributeOption" } } }, "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", "attribute_options_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." } } } }, "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": [ "Data", "Object Attribute Options" ] }, "post": { "operationId": "create_object_attribute_option", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attribute_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.UAttributeOption" } }, "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_options_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": [ "attribute_option_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": [ "Data", "Object Attribute Options" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UObjects.UAttributeOption" } } } } } }, "/data/v1/objects/{object_name}/attributes/{attribute_name}/options/{option_name}": { "get": { "operationId": "get_object_attribute_option", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attribute_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "option_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.UAttributeOption" } }, "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", "attribute_option_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": [ "Data", "Object Attribute Options" ] }, "patch": { "operationId": "update_object_attribute_option", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attribute_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "option_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.UAttributeOption" } }, "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" ] }, "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", "attribute_option_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_option_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": [ "Data", "Object Attribute Options" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UObjects.UAttributeOptionUpdate" } } } } }, "delete": { "operationId": "delete_object_attribute_option", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attribute_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "option_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", "attribute_option_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": [ "Data", "Object Attribute Options" ] } }, "/data/v1/objects/{object_name}/records": { "post": { "operationId": "create_object_record", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UObjects.UObjectName" } }, { "name": "validation_mode", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ValidationMode" }, "explode": false } ], "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": { "type": "object", "required": [ "object", "id", "created_at", "updated_at", "attributes" ], "properties": { "object": { "type": "string", "description": "The API name of the object this record is an instance of.", "readOnly": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/UValues.UUuid" } ], "description": "Unique UUID identifier for the record.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time the record was created.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time the record was last updated.", "readOnly": true }, "attributes": { "type": "object", "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/UValues.UValue" } ], "nullable": true }, "description": "Attribute values for the record. Each key is the API name of the attribute\nand each value is the corresponding attribute value for the record." } } } }, "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", "record_missing_required_field", "referenced_record_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": [ "record_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." } } } }, "503": { "description": "Response for any operation that results in service unavailability.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "service_unavailable" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in service unavailability." } } } } }, "tags": [ "Data", "Object Records" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRecordRequest" } } } } } }, "/data/v1/objects/{object_name}/records/find-unique": { "post": { "operationId": "find_unique_object_record", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UObjects.UObjectName" } } ], "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": { "type": "object", "required": [ "object", "id", "created_at", "updated_at", "attributes" ], "properties": { "object": { "type": "string", "description": "The API name of the object this record is an instance of.", "readOnly": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/UValues.UUuid" } ], "description": "Unique UUID identifier for the record.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time the record was created.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time the record was last updated.", "readOnly": true }, "attributes": { "type": "object", "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/UValues.UValue" } ], "nullable": true }, "description": "Attribute values for the record. Each key is the API name of the attribute\nand each value is the corresponding attribute value for the record." } }, "nullable": true } }, "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" ] }, "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": [ "Data", "Object Records" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindUniqueRecordRequest" } } } } } }, "/data/v1/objects/{object_name}/records/upsert": { "post": { "operationId": "upsert_object_record", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UObjects.UObjectName" } }, { "name": "validation_mode", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ValidationMode" }, "explode": false } ], "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": { "type": "object", "required": [ "object", "id", "created_at", "updated_at", "attributes" ], "properties": { "object": { "type": "string", "description": "The API name of the object this record is an instance of.", "readOnly": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/UValues.UUuid" } ], "description": "Unique UUID identifier for the record.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time the record was created.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time the record was last updated.", "readOnly": true }, "attributes": { "type": "object", "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/UValues.UValue" } ], "nullable": true }, "description": "Attribute values for the record. Each key is the API name of the attribute\nand each value is the corresponding attribute value for the record." } } } }, "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", "record_missing_required_field", "referenced_record_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": [ "record_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." } } } }, "503": { "description": "Response for any operation that results in service unavailability.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "service_unavailable" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in service unavailability." } } } } }, "tags": [ "Data", "Object Records" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertRecordRequest" } } } } } }, "/data/v1/objects/{object_name}/records/{record_id}": { "get": { "operationId": "get_object_record", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UObjects.UObjectName" } }, { "name": "record_id", "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": { "type": "object", "required": [ "object", "id", "created_at", "updated_at", "attributes" ], "properties": { "object": { "type": "string", "description": "The API name of the object this record is an instance of.", "readOnly": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/UValues.UUuid" } ], "description": "Unique UUID identifier for the record.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time the record was created.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time the record was last updated.", "readOnly": true }, "attributes": { "type": "object", "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/UValues.UValue" } ], "nullable": true }, "description": "Attribute values for the record. Each key is the API name of the attribute\nand each value is the corresponding attribute value for the record." } } } }, "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", "record_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": [ "Data", "Object Records" ] }, "patch": { "operationId": "update_object_record", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UObjects.UObjectName" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "validation_mode", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ValidationMode" }, "explode": false } ], "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": { "type": "object", "required": [ "object", "id", "created_at", "updated_at", "attributes" ], "properties": { "object": { "type": "string", "description": "The API name of the object this record is an instance of.", "readOnly": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/UValues.UUuid" } ], "description": "Unique UUID identifier for the record.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time the record was created.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time the record was last updated.", "readOnly": true }, "attributes": { "type": "object", "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/UValues.UValue" } ], "nullable": true }, "description": "Attribute values for the record. Each key is the API name of the attribute\nand each value is the corresponding attribute value for the record." } } } }, "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", "record_missing_required_field", "referenced_record_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", "record_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": [ "record_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." } } } }, "503": { "description": "Response for any operation that results in service unavailability.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "service_unavailable" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in service unavailability." } } } } }, "tags": [ "Data", "Object Records" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRecordRequest" } } } } }, "delete": { "operationId": "delete_object_record", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UObjects.UObjectName" } }, { "name": "record_id", "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", "record_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." } } } }, "503": { "description": "Response for any operation that results in service unavailability.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "service_unavailable" ] }, "message": { "type": "string" } }, "description": "Response for any operation that results in service unavailability." } } } } }, "tags": [ "Data", "Object Records" ] } } }, "security": [ { "ApiKeyAuth": [] } ], "components": { "schemas": { "CreateRecordRequest": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UValues.UValue" }, "description": "The attribute values for the new record.\n\nAll required attributes on the object must be included." } }, "description": "Request body for creating a record." }, "FindUniqueRecordRequest": { "type": "object", "required": [ "match" ], "properties": { "match": { "type": "object", "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/UValues.UValue" } ], "nullable": true }, "description": "The attribute values to match against to find an existing record.\n\nAt least one unique attribute must be included to ensure that at most one\nrecord is matched. Additional unique or non-unique attributes may also be\nincluded to refine the matching criteria." } }, "description": "Request body for finding a unique record by attribute values." }, "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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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": [ "INTEGER" ], "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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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." }, { "$ref": "#/components/schemas/UObjects.UMultiSelectAttribute" }, { "type": "object", "required": [ "type", "api_name", "display_name", "description", "is_required", "is_unique" ], "properties": { "type": { "type": "string", "enum": [ "PHONE_NUMBER" ], "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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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." }, { "$ref": "#/components/schemas/UObjects.UReferenceAttribute" }, { "$ref": "#/components/schemas/UObjects.USelectAttribute" }, { "type": "object", "required": [ "type", "api_name", "display_name", "description", "is_required", "is_unique" ], "properties": { "type": { "type": "string", "enum": [ "TEXT" ], "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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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": [ "URL" ], "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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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": [ "UUID" ], "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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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." } ], "description": "Definition of an attribute on a Unify object." }, "UObjects.UAttributeOption": { "type": "object", "required": [ "api_name", "display_name" ], "properties": { "api_name": { "type": "string", "description": "This is the unique identifier for the attribute option at the API level. It\nis unique within the attribute and cannot be changed." }, "display_name": { "type": "string", "description": "This is the user-facing attribute option name that will be shown within\nUnify. It is unique within the object and can be changed at any time." } }, "description": "Definition of an option for a `SELECT` or `MULTI_SELECT` attribute." }, "UObjects.UAttributeOptionUpdate": { "type": "object", "required": [ "display_name" ], "properties": { "display_name": { "type": "string", "description": "This is the user-facing attribute option name that will be shown within\nUnify. It is unique within the object and can be changed at any time." } }, "description": "Definition of an option for a `SELECT` or `MULTI_SELECT` attribute." }, "UObjects.UAttributeOptionUpdateItem": { "type": "object", "required": [ "display_name" ], "properties": { "display_name": { "type": "string", "description": "This is the user-facing attribute option name that will be shown within\nUnify. It is unique within the object and can be changed at any time." } }, "description": "Definition of an option for a `SELECT` or `MULTI_SELECT` attribute." }, "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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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." }, "UObjects.UMultiSelectAttribute": { "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": [ "MULTI_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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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." } ], "description": "Definition of a \"multi-select\" attribute on a Unify object." }, "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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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.UObject": { "type": "object", "required": [ "provider", "api_name", "display_name", "description" ], "properties": { "provider": { "allOf": [ { "$ref": "#/components/schemas/UObjects.UObjectProvider" } ], "description": "The provider of an object represents who created and manages the object in\nUnify. This is used to differentiate between standard objects provided by\nUnify and custom objects created by a plugin or user.", "readOnly": true }, "api_name": { "type": "string", "description": "This is the unique identifier for the object at the API level. It is unique\nwithin Unify and cannot be changed." }, "display_name": { "type": "string", "description": "This is the user-facing object name shown within Unify. It is not required\nto be unique within Unify and can be changed at any time." }, "description": { "type": "string", "nullable": true, "description": "This is a description of the object. It is not required but will be shown\nin the UI to help understand the purpose of the object. Typically, this\nshould be a short sentence or two explaining the object." } } }, "UObjects.UObjectName": { "type": "string" }, "UObjects.UObjectProvider": { "type": "string", "enum": [ "UNIFY", "CUSTOMER" ], "description": "Represents who created and manages an object in Unify.\n\nIn most ways, all objects within the Unify platform behave the same way\nregardless of whether they are defined by Unify or as custom objects by a\nplugin or user. This includes the ability to define custom attributes and\naccess records via API.\n\nHowever, there are some subtle distinctions that require differentiating\nbetween these classifications of objects. This enumeration is used to\nrepresent these distinctions." }, "UObjects.UObjectUpdate": { "type": "object", "required": [ "display_name", "description" ], "properties": { "display_name": { "type": "string", "description": "This is the user-facing object name shown within Unify. It is not required\nto be unique within Unify and can be changed at any time." }, "description": { "type": "string", "nullable": true, "description": "This is a description of the object. It is not required but will be shown\nin the UI to help understand the purpose of the object. Typically, this\nshould be a short sentence or two explaining the object." } } }, "UObjects.UReferenceAttribute": { "type": "object", "required": [ "cardinality", "related_object", "related_attribute" ], "properties": { "cardinality": { "allOf": [ { "$ref": "#/components/schemas/UObjects.UReferenceCardinality" } ], "description": "The cardinality of the reference attribute." }, "related_object": { "type": "string", "description": "The API name of the object that this attribute references." }, "related_attribute": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UObjects.URelatedReferenceAttribute" } ], "nullable": true, "description": "The optional related attribute on the referenced object. When this exists,\nthe relationship between the two objects is bidirectional." } }, "allOf": [ { "type": "object", "required": [ "type", "api_name", "display_name", "description", "is_required", "is_unique" ], "properties": { "type": { "type": "string", "enum": [ "REFERENCE" ], "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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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." } ], "description": "Definition of a \"reference\" attribute on a Unify object." }, "UObjects.UReferenceAttributeUpdate": { "type": "object", "required": [ "cardinality", "related_object", "related_attribute" ], "properties": { "cardinality": { "allOf": [ { "$ref": "#/components/schemas/UObjects.UReferenceCardinality" } ], "description": "The cardinality of the reference attribute." }, "related_object": { "type": "string", "description": "The API name of the object that this attribute references." }, "related_attribute": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/UObjects.URelatedReferenceAttribute" } ], "nullable": true, "description": "The optional related attribute on the referenced object. When this exists,\nthe relationship between the two objects is bidirectional." } }, "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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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 \"reference\" attribute on a Unify object." }, "UObjects.UReferenceCardinality": { "type": "string", "enum": [ "ONE", "MANY" ] }, "UObjects.URelatedReferenceAttribute": { "type": "object", "required": [ "api_name", "display_name", "cardinality" ], "properties": { "api_name": { "type": "string" }, "display_name": { "type": "string" }, "cardinality": { "$ref": "#/components/schemas/UObjects.UReferenceCardinality" } } }, "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\nunique 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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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." } ], "description": "Definition of a \"select\" attribute on a Unify object." }, "UObjects.USelectAttributeUpdate": { "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\nis 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\nshown in the UI to help understand the purpose of the object. Typically,\nthis 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 \"select\" 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", "additionalProperties": {} } ], "description": "Validation error detail returned for bad request responses." }, "UValues.UAddress": { "type": "object", "properties": { "country": { "allOf": [ { "$ref": "#/components/schemas/UValues.UCountry" } ], "description": "Country code in ISO 3166-1 alpha-2 format." }, "administrative_area": { "type": "string", "description": "State, province, region, or territory." }, "sub_administrative_area": { "type": "string", "description": "County or other secondary governmental division of an administrative area." }, "locality": { "type": "string", "description": "City, town, or village." }, "dependent_locality": { "type": "string", "description": "Neighborhood, borough, district, or city sector." }, "postal_code": { "type": "string", "description": "Postal code or ZIP code." }, "thoroughfare": { "type": "string", "description": "Street name with elements such as street type or direction." }, "premise": { "type": "string", "description": "Street number or building name." }, "sub_premise": { "type": "string", "description": "Apartment, suite, office number, or other secondary unit designator." } }, "description": "Composite object representing a physical address.", "title": "UAddress" }, "UValues.UBoolean": { "type": "boolean", "description": "Boolean value.", "title": "UBoolean" }, "UValues.UCountry": { "type": "object", "required": [ "code", "name" ], "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/UValues.UCountryCode" } ], "description": "Country code." }, "name": { "type": "string", "description": "Country name." } }, "description": "Composite object representing a country.", "title": "UCountry" }, "UValues.UCountryCode": { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "description": "ISO 3166-1 alpha-2 country code.", "title": "UCountryCode" }, "UValues.UCurrency": { "type": "object", "required": [ "code", "value" ], "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/UValues.UCurrencyCode" } ], "description": "Currency code." }, "value": { "type": "number", "format": "decimal", "description": "Currency value." } }, "description": "Composite object representing a currency value.", "title": "UCurrency" }, "UValues.UCurrencyCode": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMW" ], "description": "ISO 4217 currency code.", "title": "UCurrencyCode" }, "UValues.UDate": { "type": "string", "description": "String value representing a date.", "title": "UDate" }, "UValues.UDatetime": { "type": "string", "description": "String value representing a datetime.", "title": "UDatetime" }, "UValues.UDecimal": { "type": "number", "description": "Decimal value.", "title": "UDecimal" }, "UValues.UEmail": { "type": "string", "format": "email", "description": "String value representing an email address.", "title": "UEmail" }, "UValues.UInteger": { "type": "integer", "description": "Integer value.", "title": "UInteger" }, "UValues.UMultiSelect": { "type": "array", "items": { "type": "string" }, "description": "String array that contains strings from a specific set of allowed values.", "title": "UMultiSelect" }, "UValues.UPhoneNumber": { "type": "string", "description": "String value representing a phone number.", "title": "UPhoneNumber" }, "UValues.UReferenceById": { "type": "object", "required": [ "id" ], "properties": { "id": { "allOf": [ { "$ref": "#/components/schemas/UValues.UUuid" } ], "description": "An object record ID." } }, "description": "Reference to another object record by ID.\n\nThis will find an existing record by its ID, and an error will be returned if\nthe record does not exist.", "title": "UReferenceById" }, "UValues.UReferenceByMatch": { "type": "object", "required": [ "match" ], "properties": { "match": { "type": "object", "additionalProperties": {}, "description": "The attribute values to match against to find an existing record.\n\nAt least one unique attribute must be included to ensure that at most one\nrecord is matched. Additional unique or non-unique attributes may also be\nincluded to refine the matching criteria." } }, "description": "Reference to another object record by match criteria.\n\nThis will find an existing record using the provided match criteria, and\n`null` will be returned if no match is found.", "title": "UReferenceByMatch" }, "UValues.UReferenceByUpsert": { "type": "object", "required": [ "match" ], "properties": { "match": { "type": "object", "additionalProperties": {}, "description": "The attribute values to match against to find an existing record.\n\nAt least one unique attribute must be included to ensure that at most one\nrecord is matched. Additional unique or non-unique attributes may also be\nincluded to refine the matching criteria." }, "create": { "type": "object", "additionalProperties": {}, "description": "The attribute values to use when creating a new record if no match is found." }, "update": { "type": "object", "additionalProperties": {}, "description": "The attribute values to use when updating an existing record if a match is found." }, "update_if_empty": { "type": "object", "additionalProperties": {}, "description": "The attribute values to update when a matching record is found and the\nexisting attribute value on the record is `null`." }, "create_or_update": { "type": "object", "additionalProperties": {}, "description": "The attribute values to apply during both creation and update operations." }, "create_or_update_if_empty": { "type": "object", "additionalProperties": {}, "description": "The attribute values to apply during both creation and update-if-empty\noperations." } }, "description": "Reference to another object record by performing a nested upsert.\n\nAt least one of `create`, `create_or_update` or `create_or_update_if_empty`\nmust be provided, and all required attributes on the object must be included\nin at least one of these properties.\n\n## Precedence\n\nWhen the same attribute is specified in multiple properties, the values will\nbe applied in a specific order of precedence. If a record is being created,\nthe following order is used:\n\n1. `create`\n2. `create_or_update`\n3. `create_or_update_if_empty`\n\nIf an existing record is being updated, the following order is used:\n\n1. `update`\n2. `create_or_update`\n3. `update_if_empty`\n4. `create_or_update_if_empty`", "title": "UReferenceByUpsert" }, "UValues.USelect": { "type": "string", "description": "String value that matches one of a specific set of allowed values.", "title": "USelect" }, "UValues.UText": { "type": "string", "description": "String value.", "title": "UText" }, "UValues.UUrl": { "type": "string", "description": "String value representing a web URL or internet domain.", "title": "UUrl" }, "UValues.UUuid": { "type": "string", "description": "String UUIDv4 value.", "title": "UUuid" }, "UValues.UValue": { "anyOf": [ { "$ref": "#/components/schemas/UValues.UAddress" }, { "$ref": "#/components/schemas/UValues.UBoolean" }, { "$ref": "#/components/schemas/UValues.UCountry" }, { "$ref": "#/components/schemas/UValues.UCurrency" }, { "$ref": "#/components/schemas/UValues.UDate" }, { "$ref": "#/components/schemas/UValues.UDatetime" }, { "$ref": "#/components/schemas/UValues.UDecimal" }, { "$ref": "#/components/schemas/UValues.UEmail" }, { "$ref": "#/components/schemas/UValues.UInteger" }, { "$ref": "#/components/schemas/UValues.UMultiSelect" }, { "$ref": "#/components/schemas/UValues.UPhoneNumber" }, { "anyOf": [ { "$ref": "#/components/schemas/UValues.UReferenceById" }, { "$ref": "#/components/schemas/UValues.UReferenceByMatch" }, { "$ref": "#/components/schemas/UValues.UReferenceByUpsert" } ] }, { "$ref": "#/components/schemas/UValues.USelect" }, { "$ref": "#/components/schemas/UValues.UText" }, { "$ref": "#/components/schemas/UValues.UUrl" }, { "$ref": "#/components/schemas/UValues.UUuid" } ] }, "UpdateRecordRequest": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UValues.UValue" }, "description": "The attribute values to update in the record." } }, "description": "Request body for updating a record." }, "UpsertRecordRequest": { "type": "object", "required": [ "match" ], "properties": { "match": { "type": "object", "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/UValues.UValue" } ], "nullable": true }, "description": "The attribute values to match against to find an existing record.\n\nAt least one unique attribute must be included to ensure that at most one\nrecord is matched. Additional unique or non-unique attributes may also be\nincluded to refine the matching criteria." }, "create": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UValues.UValue" }, "description": "The attribute values to use when creating a new record if no match is found." }, "update": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UValues.UValue" }, "description": "The attribute values to use when updating an existing record if a match is found." }, "update_if_empty": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UValues.UValue" }, "description": "The attribute values to update when a matching record is found and the\nexisting attribute value on the record is `null`." }, "create_or_update": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UValues.UValue" }, "description": "The attribute values to apply during both creation and update operations." }, "create_or_update_if_empty": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UValues.UValue" }, "description": "The attribute values to apply during both creation and update-if-empty\noperations." } }, "description": "Request body for upserting a record.\n\nAt least one of `create`, `create_or_update` or `create_or_update_if_empty`\nmust be provided, and all required attributes on the object must be included\nin at least one of these properties.\n\n## Precedence\n\nWhen the same attribute is specified in multiple properties, the values will\nbe applied in a specific order of precedence. If a record is being created,\nthe following order is used:\n\n1. `create`\n2. `create_or_update`\n3. `create_or_update_if_empty`\n\nIf an existing record is being updated, the following order is used:\n\n1. `update`\n2. `create_or_update`\n3. `update_if_empty`\n4. `create_or_update_if_empty`" }, "ValidationMode": { "type": "string", "enum": [ "strict", "ignore_invalid" ], "description": "Validation mode to use when validating request data.\n\n`strict` validation will fail requests if any attribute fails validation,\nincluding unrecognized attributes.\n\n`ignore_invalid` validation will strip out unknown attributes and replace\nknown, non-required attributes with `undefined` if they fail validation.\nThe request will still fail if the request body does not contain the proper\nstructure or if any required attributes fail validation." } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } } }, "servers": [ { "url": "https://api.unifygtm.com", "variables": {} } ] }