From 62be14e2129ef9cfc41e9127dd9fc49790653c4f Mon Sep 17 00:00:00 2001 From: Troy Taylor <44444967+troystaylor@users.noreply.github.com> Date: Thu, 7 Mar 2024 01:27:00 -0500 Subject: [PATCH] HubSpot Engagements V2 (Independent Publisher) Plugin (#3178) * Add files via upload * Update apiDefinition.swagger.json --- .../apiDefinition.swagger.json | 18721 ++++++++++++++++ .../HubSpot Engagements V2/apiProperties.json | 23 + .../HubSpot Engagements V2/readme.md | 183 + 3 files changed, 18927 insertions(+) create mode 100644 independent-publisher-connectors/HubSpot Engagements V2/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/HubSpot Engagements V2/apiProperties.json create mode 100644 independent-publisher-connectors/HubSpot Engagements V2/readme.md diff --git a/independent-publisher-connectors/HubSpot Engagements V2/apiDefinition.swagger.json b/independent-publisher-connectors/HubSpot Engagements V2/apiDefinition.swagger.json new file mode 100644 index 000000000..56556fb57 --- /dev/null +++ b/independent-publisher-connectors/HubSpot Engagements V2/apiDefinition.swagger.json @@ -0,0 +1,18721 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0.0", + "title": "HubSpot Engagements V2", + "description": "HubSpot Engagements is used for keeping your CRM records up-to-date on any interactions that take place outside of HubSpot. Activity reporting in the CRM also feeds off of this data.", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "api.hubapi.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/crm/v3/objects/calls/batch/create": { + "post": { + "summary": "Create batch of calls", + "description": "Creates a batch of calls.", + "operationId": "CreateABatchOfCalls", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/calls/batch/read": { + "post": { + "summary": "Get batch of calls", + "description": "Retrieves a batch of calls by internal ID, or unique property values.", + "operationId": "ReadABatchOfCallsByInternalIdOrUniquePropertyValues", + "parameters": [ + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "propertiesWithHistory": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties with history.", + "title": "Properties With History" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/calls/batch/update": { + "post": { + "summary": "Update batch of calls", + "description": "Updates a batch of calls.", + "operationId": "UpdateABatchOfCalls", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/calls/batch/archive": { + "post": { + "summary": "Archive batch of calls", + "description": "Archives a batch of calls by ID.", + "operationId": "ArchiveABatchOfCallsById", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/calls": { + "get": { + "summary": "List calls", + "description": "Retrieves a page of calls. Control what is returned via the `properties` query param.", + "operationId": "List", + "parameters": [ + { + "name": "limit", + "default": 10, + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "type": "integer", + "format": "int32", + "required": false + }, + { + "name": "after", + "in": "query", + "x-ms-summary": "After", + "description": "The after.", + "type": "string", + "required": false + }, + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + }, + "title": "Results" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "List", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "post": { + "summary": "Create a call", + "description": "Creates a call with the given properties and return a copy of the object, including the ID.", + "operationId": "CreateCall", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "CreateCall", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/calls/{callId}": { + "get": { + "summary": "Read an object", + "description": "Retrieves an object identified by 'callId'. 'callId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId": "ReadObject", + "parameters": [ + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "callId", + "in": "path", + "x-ms-summary": "Call ID", + "x-ms-url-encoding": "single", + "description": "The call identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ReadObject", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "delete": { + "summary": "Archive an object", + "description": "Moves an object identified by 'callId' to the recycling bin.", + "operationId": "Archive", + "parameters": [ + { + "name": "callId", + "in": "path", + "x-ms-summary": "Call ID", + "x-ms-url-encoding": "single", + "description": "The call identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + }, + "patch": { + "summary": "Update an object", + "description": "Performs a partial update of an object identified by 'callId'. 'callId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "UpdateObject", + "parameters": [ + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "callId", + "in": "path", + "x-ms-summary": "Call ID", + "x-ms-url-encoding": "single", + "description": "The call identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": false, + "operations": [ + { + "operationId": "UpdateObject", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/calls/merge": { + "post": { + "summary": "Merge two calls", + "description": "Merges two calls with same type.", + "operationId": "MergeTwoCallsWithSameType", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectIdToMerge": { + "type": "string", + "description": "The object identifier to merge.", + "title": "Object ID To Merge" + }, + "primaryObjectId": { + "type": "string", + "description": "The primary object identifier.", + "title": "Primary Object ID" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/calls/gdpr-delete": { + "post": { + "summary": "Delete a call - GDPR", + "description": "Permanently deletes a call and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.", + "operationId": "GdprDelete", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "The object identifier.", + "title": "Object ID" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/calls/search": { + "post": { + "summary": "Search calls", + "description": "Retrieves a list of calls.", + "operationId": "Post-_crm_v3_objects_calls_search", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "filterGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "operator": { + "type": "string", + "description": "The operator.", + "title": "Operator" + }, + "propertyName": { + "type": "string", + "description": "The property name.", + "title": "Property Name" + }, + "value": { + "type": "string", + "description": "The value.", + "title": "Value" + }, + "highValue": { + "type": "string", + "description": "The high value.", + "title": "High Value" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The values.", + "title": "Values" + } + } + }, + "title": "Filters" + } + } + }, + "title": "Filter Groups" + }, + "limit": { + "type": "string", + "description": "The limit.", + "title": "Limit" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "sorts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sorts.", + "title": "Sorts" + }, + "query": { + "type": "string", + "description": "The query.", + "title": "Query" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total.", + "title": "Total" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/emails/batch/create": { + "post": { + "summary": "Create a batch of emails", + "description": "Creates a batch of emails.", + "operationId": "CreateABatchOfEmails", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": false, + "operations": [ + { + "operationId": "CreateABatchOfEmails", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/emails/batch/read": { + "post": { + "summary": "Get batch of emails", + "description": "Retrieves a batch of emails by internal ID, or unique property values.", + "operationId": "ReadABatchOfEmailsByInternalIdOrUniquePropertyValues", + "parameters": [ + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "propertiesWithHistory": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties with history.", + "title": "Properties With History" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/emails/batch/archive": { + "post": { + "summary": "Archive batch of emails", + "description": "Archives a batch of emails by ID.", + "operationId": "ArchiveABatchOfEmailsById", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/emails/batch/update": { + "post": { + "summary": "Update batch of emails", + "description": "Updates a batch of emails.", + "operationId": "UpdateABatchOfEmails", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/emails": { + "get": { + "summary": "List emails", + "description": "Retrieves a page of emails. Control what is returned via the `properties` query param.", + "operationId": "ListEmails", + "parameters": [ + { + "name": "limit", + "default": 10, + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "type": "integer", + "format": "int32", + "required": false + }, + { + "name": "after", + "in": "query", + "x-ms-summary": "After", + "description": "The after.", + "type": "string", + "required": false + }, + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + }, + "title": "Results" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ListEmails", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "post": { + "summary": "Create an email", + "description": "Creates an email with the given properties and return a copy of the object, including the ID.", + "operationId": "CreateEmail", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "CreateEmail", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/emails/{emailId}": { + "get": { + "summary": "Get email", + "description": "Retrieves an object identified by 'emailId'. 'emailId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId": "ReadEmail", + "parameters": [ + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "emailId", + "in": "path", + "x-ms-summary": "Email ID", + "x-ms-url-encoding": "single", + "description": "The email identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ReadEmail", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "delete": { + "summary": "Archive email", + "description": "Moves an object identified by 'emailId' to the recycling bin.", + "operationId": "Archive19", + "parameters": [ + { + "name": "emailId", + "in": "path", + "x-ms-summary": "Email ID", + "x-ms-url-encoding": "single", + "description": "The email identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + }, + "patch": { + "summary": "Update email", + "description": "Performs a partial update of an object identified by 'emailId'. 'emailId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "Update20", + "parameters": [ + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "emailId", + "in": "path", + "x-ms-summary": "Email ID", + "x-ms-url-encoding": "single", + "description": "The email identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/emails/merge": { + "post": { + "summary": "Merge two emails", + "description": "Merges two emails with same type.", + "operationId": "MergeTwoEmailsWithSameType", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectIdToMerge": { + "type": "string", + "description": "The object identifier to merge.", + "title": "Object ID To Merge" + }, + "primaryObjectId": { + "type": "string", + "description": "The primary object identifier.", + "title": "Primary Object ID" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/emails/gdpr-delete": { + "post": { + "summary": "Delete an email - GDPR", + "description": "Permanently deletes an email and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.", + "operationId": "GdprDelete22", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "The object identifier.", + "title": "Object ID" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/emails/search": { + "post": { + "summary": "Search email", + "description": "Retrieve a list of emails.", + "operationId": "Post-_crm_v3_objects_emails_search", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "filterGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "operator": { + "type": "string", + "description": "The operator.", + "title": "Operator" + }, + "propertyName": { + "type": "string", + "description": "The property name.", + "title": "Property Name" + }, + "value": { + "type": "string", + "description": "The value.", + "title": "Value" + }, + "highValue": { + "type": "string", + "description": "The high value.", + "title": "High Value" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The values.", + "title": "Values" + } + } + }, + "title": "Filters" + } + } + }, + "title": "Filter Groups" + }, + "limit": { + "type": "string", + "description": "The limit.", + "title": "Limit" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "sorts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sorts.", + "title": "Sorts" + }, + "query": { + "type": "string", + "description": "The query.", + "title": "Query" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total.", + "title": "Total" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/meetings/batch/update": { + "post": { + "summary": "Update batch of meetings", + "description": "Updates a batch of meetings.", + "operationId": "UpdateABatchOfMeetings", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/meetings/batch/archive": { + "post": { + "summary": "Archive batch of meetings", + "description": "Archives a batch of meetings by ID.", + "operationId": "ArchiveABatchOfMeetingsById", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/meetings/batch/read": { + "post": { + "summary": "Get batch of meetings", + "description": "Retrieves a batch of meetings by internal ID, or unique property values.", + "operationId": "ReadABatchOfMeetingsByInternalIdOrUniquePropertyValues", + "parameters": [ + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "propertiesWithHistory": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties with history.", + "title": "Properties With History" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/meetings/batch/create": { + "post": { + "summary": "Create a batch of meetings", + "description": "Creates a batch of meetings.", + "operationId": "CreateABatchOfMeetings", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/meetings/{meetingId}": { + "get": { + "summary": "Get meeting", + "description": "Retrieves an object identified by 'meetingId'. 'meetingId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId": "ReadMeeting", + "parameters": [ + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "meetingId", + "in": "path", + "x-ms-summary": "Meeting ID", + "x-ms-url-encoding": "single", + "description": "The meeting identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ReadMeeting", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "delete": { + "summary": "Archive meeting", + "description": "Moves an object identified by 'meetingId' to the recycling bin.", + "operationId": "Archive29", + "parameters": [ + { + "name": "meetingId", + "in": "path", + "x-ms-summary": "Meeting ID", + "x-ms-url-encoding": "single", + "description": "The meeting identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + }, + "patch": { + "summary": "Update meeting", + "description": "Performs a partial update of an object identified by 'meetingId'. 'meetingId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "UpdateMeeting", + "parameters": [ + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "meetingId", + "in": "path", + "x-ms-summary": "Meeting ID", + "x-ms-url-encoding": "single", + "description": "The meeting identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "UpdateMeeting", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/meetings": { + "get": { + "summary": "List meetings", + "description": "Retrieves a page of meetings. Control what is returned via the `properties` query param.", + "operationId": "ListMeetings", + "parameters": [ + { + "name": "limit", + "default": 10, + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "type": "integer", + "format": "int32", + "required": false + }, + { + "name": "after", + "in": "query", + "x-ms-summary": "After", + "description": "The after.", + "type": "string", + "required": false + }, + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + }, + "title": "Results" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ListMeetings", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "post": { + "summary": "Create meeting", + "description": "Creates a meeting with the given properties and return a copy of the object, including the ID.", + "operationId": "CreateMeeting", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "CreateMeeting", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/meetings/merge": { + "post": { + "summary": "Merge two meetings", + "description": "Merges two meetings with same type.", + "operationId": "MergeTwoMeetingsWithSameType", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectIdToMerge": { + "type": "string", + "description": "The object identifier to merge.", + "title": "Object ID To Merge" + }, + "primaryObjectId": { + "type": "string", + "description": "The primary object identifier.", + "title": "Primary Object ID" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/meetings/gdpr-delete": { + "post": { + "summary": "Delete a meeting - GDPR", + "description": "Permanently deletes a meeting and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.", + "operationId": "GdprDelete34", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "The object identifier.", + "title": "Object ID" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/meetings/search": { + "post": { + "summary": "Search meetings", + "description": "Retrieve a list of meetings.", + "operationId": "Post-_crm_v3_objects_meetings_search", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "filterGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "operator": { + "type": "string", + "description": "The operator.", + "title": "Operator" + }, + "propertyName": { + "type": "string", + "description": "The property name.", + "title": "Property Name" + }, + "value": { + "type": "string", + "description": "The value.", + "title": "Value" + }, + "highValue": { + "type": "string", + "description": "The high value.", + "title": "High Value" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The values.", + "title": "Values" + } + } + }, + "title": "Filters" + } + } + }, + "title": "Filter Groups" + }, + "limit": { + "type": "string", + "description": "The limit.", + "title": "Limit" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "sorts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sorts.", + "title": "Sorts" + }, + "query": { + "type": "string", + "description": "The query.", + "title": "Query" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total.", + "title": "Total" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/notes/batch/read": { + "post": { + "summary": "Get batch of notes", + "description": "Retrieves a batch of notes by internal ID, or unique property values.", + "operationId": "ReadABatchOfNotesByInternalIdOrUniquePropertyValues", + "parameters": [ + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "propertiesWithHistory": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties with history.", + "title": "Properties With History" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/notes/batch/archive": { + "post": { + "summary": "Archive batch of notes", + "description": "Archives a batch of notes by ID.", + "operationId": "ArchiveABatchOfNotesById", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/notes/batch/update": { + "post": { + "summary": "Update batch of notes", + "description": "Updates a batch of notes.", + "operationId": "UpdateABatchOfNotes", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/notes/batch/create": { + "post": { + "summary": "Create a batch of notes", + "description": "Creates a batch of notes.", + "operationId": "CreateABatchOfNotes", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/notes": { + "get": { + "summary": "List notes", + "description": "Retrieves a page of notes. Control what is returned via the `properties` query param.", + "operationId": "ListNotes", + "parameters": [ + { + "name": "limit", + "default": 10, + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "type": "integer", + "format": "int32", + "required": false + }, + { + "name": "after", + "in": "query", + "x-ms-summary": "After", + "description": "The after.", + "type": "string", + "required": false + }, + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + }, + "title": "Results" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ListNotes", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "post": { + "summary": "Create note", + "description": "Creates a note with the given properties and return a copy of the object, including the ID.", + "operationId": "CreateNote", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "CreateNote", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/notes/{noteId}": { + "get": { + "summary": "Get note", + "description": "Retrieves an object identified by 'noteId'. 'noteId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId": "ReadNote", + "parameters": [ + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "noteId", + "in": "path", + "x-ms-summary": "Note ID", + "x-ms-url-encoding": "single", + "description": "The note identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ReadNote", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "delete": { + "summary": "Archive note", + "description": "Moves an object identified by 'noteId' to the recycling bin.", + "operationId": "Archive43", + "parameters": [ + { + "name": "noteId", + "in": "path", + "x-ms-summary": "Note ID", + "x-ms-url-encoding": "single", + "description": "The note identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + }, + "patch": { + "summary": "Update note", + "description": "Performs a partial update of an object identified by 'noteId'. 'noteId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "UpdateNote", + "parameters": [ + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "noteId", + "in": "path", + "x-ms-summary": "Note ID", + "x-ms-url-encoding": "single", + "description": "The note identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": false, + "operations": [ + { + "operationId": "UpdateNOte", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/notes/merge": { + "post": { + "summary": "Merge two notes", + "description": "Merges two notes with same type.", + "operationId": "MergeTwoNotesWithSameType", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectIdToMerge": { + "type": "string", + "description": "The object identifier to merge.", + "title": "Object ID To Merge" + }, + "primaryObjectId": { + "type": "string", + "description": "The primary object identifier.", + "title": "Primary Object ID" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/notes/gdpr-delete": { + "post": { + "summary": "Delete a note - GDPR", + "description": "Permanently deletes a note and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.", + "operationId": "GdprDelete46", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "The object identifier.", + "title": "Object ID" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/notes/search": { + "post": { + "summary": "Search notes", + "description": "Retrieves a list of notes.", + "operationId": "Post-_crm_v3_objects_notes_search", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "filterGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "operator": { + "type": "string", + "description": "The operator.", + "title": "Operator" + }, + "propertyName": { + "type": "string", + "description": "The property name.", + "title": "Property Name" + }, + "value": { + "type": "string", + "description": "The value.", + "title": "Value" + }, + "highValue": { + "type": "string", + "description": "The high value.", + "title": "High Value" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The values.", + "title": "Values" + } + } + }, + "title": "Filters" + } + } + }, + "title": "Filter Groups" + }, + "limit": { + "type": "string", + "description": "The limit.", + "title": "Limit" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "sorts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sorts.", + "title": "Sorts" + }, + "query": { + "type": "string", + "description": "The query.", + "title": "Query" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total.", + "title": "Total" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/postal_mail/batch/read": { + "post": { + "summary": "Get batch of postal mail", + "description": "Retrieves a batch of postal mail by internal ID, or unique property values.", + "operationId": "ReadABatchOfPostalMailByInternalIdOrUniquePropertyValues", + "parameters": [ + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "propertiesWithHistory": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties with history.", + "title": "Properties With History" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/postal_mail/batch/archive": { + "post": { + "summary": "Archive batch of postal mail", + "description": "Archives a batch of postal mail by ID.", + "operationId": "ArchiveABatchOfPostalMailById", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/postal_mail/batch/create": { + "post": { + "summary": "Create a batch of postal mail", + "description": "Creates a batch of postal mail.", + "operationId": "CreateABatchOfPostalMail", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/postal_mail/batch/update": { + "post": { + "summary": "Update batch of postal mail", + "description": "Updates a batch of postal mail.", + "operationId": "UpdateABatchOfPostalMail", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/postal_mail": { + "get": { + "summary": "List postal mail", + "description": "Retrieves a page of postal mail. Control what is returned via the `properties` query param.", + "operationId": "ListPostalMail", + "parameters": [ + { + "name": "limit", + "default": 10, + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "type": "integer", + "format": "int32", + "required": false + }, + { + "name": "after", + "in": "query", + "x-ms-summary": "After", + "description": "The after.", + "type": "string", + "required": false + }, + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + }, + "title": "Results" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ListPostalMail", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "post": { + "summary": "Create postal mail", + "description": "Creates a postal mail with the given properties and return a copy of the object, including the ID.", + "operationId": "CreatePostalMail", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "CreatePostalMail", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/postal_mail/{postalMailId}": { + "get": { + "summary": "Get postal mail", + "description": "Retrieves an object identified by 'postalMailId'. 'postalMailId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId": "ReadPostalMail", + "parameters": [ + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "postalMailId", + "in": "path", + "x-ms-summary": "Postal Mail ID", + "x-ms-url-encoding": "single", + "description": "The postal mail identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ReadPostalMail", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "delete": { + "summary": "Archive postal mail", + "description": "Moves an object identified by 'postalMailId' to the recycling bin.", + "operationId": "Archive55", + "parameters": [ + { + "name": "postalMailId", + "in": "path", + "x-ms-summary": "Postal Mail ID", + "x-ms-url-encoding": "single", + "description": "The postal mail identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + }, + "patch": { + "summary": "Update postal mail", + "description": "Performs a partial update of an object identified by 'postalMailId'. 'postalMailId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "Update56", + "parameters": [ + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "postalMailId", + "in": "path", + "x-ms-summary": "Postal Mail ID", + "x-ms-url-encoding": "single", + "description": "The postal mail identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/postal_mail/merge": { + "post": { + "summary": "Merge two postal mail", + "description": "Merges two postal mail with same type.", + "operationId": "MergeTwoPostalMailWithSameType", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectIdToMerge": { + "type": "string", + "description": "The object identifier to merge.", + "title": "Object ID To Merge" + }, + "primaryObjectId": { + "type": "string", + "description": "The primary object identifier.", + "title": "Primary Object ID" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/postal_mail/gdpr-delete": { + "post": { + "summary": "Delete a postal mail - GDPR", + "description": "Permanently deletes a postal mail and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.", + "operationId": "GdprDelete58", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "The object identifier.", + "title": "Object ID" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/postal_mail/search": { + "post": { + "summary": "Search postal mail", + "description": "Retrieve a list of postal mail.", + "operationId": "Post-_crm_v3_objects_postalMail_search", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "filterGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "operator": { + "type": "string", + "description": "The operator.", + "title": "Operator" + }, + "propertyName": { + "type": "string", + "description": "The property name.", + "title": "Property Name" + }, + "value": { + "type": "string", + "description": "The value.", + "title": "Value" + }, + "highValue": { + "type": "string", + "description": "The high value.", + "title": "High Value" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The values.", + "title": "Values" + } + } + }, + "title": "Filters" + } + } + }, + "title": "Filter Groups" + }, + "limit": { + "type": "string", + "description": "The limit.", + "title": "Limit" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "sorts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sorts.", + "title": "Sorts" + }, + "query": { + "type": "string", + "description": "The query.", + "title": "Query" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total.", + "title": "Total" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks/batch/archive": { + "post": { + "summary": "Archive batch of tasks", + "description": "Archives a batch of tasks by ID.", + "operationId": "ArchiveABatchOfTasksById", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks/batch/create": { + "post": { + "summary": "Create a batch of tasks", + "description": "Creates a batch of tasks.", + "operationId": "CreateABatchOfTasks", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks/batch/update": { + "post": { + "summary": "Update batch of tasks", + "description": "Updates a batch of tasks.", + "operationId": "UpdateABatchOfTasks", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks/batch/read": { + "post": { + "summary": "Get batch of tasks", + "description": "Retrieves a batch of tasks by internal ID, or unique property values.", + "operationId": "ReadABatchOfTasksByInternalIdOrUniquePropertyValues", + "parameters": [ + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "propertiesWithHistory": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties with history.", + "title": "Properties With History" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks/{taskId}": { + "get": { + "summary": "Get task", + "description": "Retrieves an object identified by 'taskId'. 'taskId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId": "ReadTask", + "parameters": [ + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "taskId", + "in": "path", + "x-ms-summary": "Task ID", + "x-ms-url-encoding": "single", + "description": "The task identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": false, + "operations": [ + { + "operationId": "ReadTask", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "delete": { + "summary": "Archive task", + "description": "Moves an object identified by 'taskId' to the recycling bin.", + "operationId": "ArchiveTask", + "parameters": [ + { + "name": "taskId", + "in": "path", + "x-ms-summary": "Task ID", + "x-ms-url-encoding": "single", + "description": "The task identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": false, + "operations": [ + { + "operationId": "ArchiveTask", + "x-ms-require-user-confirmation": true + } + ] + } + }, + "patch": { + "summary": "Update task", + "description": "Performs a partial update of an object identified by 'taskId'. 'taskId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "UpdateTask", + "parameters": [ + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "taskId", + "in": "path", + "x-ms-summary": "Task ID", + "x-ms-url-encoding": "single", + "description": "The task identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks": { + "get": { + "summary": "List tasks", + "description": "Retrieves a page of tasks. Control what is returned via the `properties` query param.", + "operationId": "List67", + "parameters": [ + { + "name": "limit", + "default": 10, + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "type": "integer", + "format": "int32", + "required": false + }, + { + "name": "after", + "in": "query", + "x-ms-summary": "After", + "description": "The after.", + "type": "string", + "required": false + }, + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + }, + "title": "Results" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + }, + "post": { + "summary": "Create task", + "description": "Creates a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.", + "operationId": "Create68", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks/merge": { + "post": { + "summary": "Merge two tasks", + "description": "Merges two tasks with same type.", + "operationId": "MergeTwoTasksWithSameType", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectIdToMerge": { + "type": "string", + "description": "The object identifier to merge.", + "title": "Object ID To Merge" + }, + "primaryObjectId": { + "type": "string", + "description": "The primary object identifier.", + "title": "Primary Object ID" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks/gdpr-delete": { + "post": { + "summary": "Delete a task - GDPR", + "description": "Permanently deletes a task and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.", + "operationId": "GdprDelete70", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "The object identifier.", + "title": "Object ID" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/tasks/search": { + "post": { + "summary": "Search tasks", + "description": "Retrieve a list of tasks.", + "operationId": "Post-_crm_v3_objects_tasks_search", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "filterGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "operator": { + "type": "string", + "description": "The operator.", + "title": "Operator" + }, + "propertyName": { + "type": "string", + "description": "The property name.", + "title": "Property Name" + }, + "value": { + "type": "string", + "description": "The value.", + "title": "Value" + }, + "highValue": { + "type": "string", + "description": "The high value.", + "title": "High Value" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The values.", + "title": "Values" + } + } + }, + "title": "Filters" + } + } + }, + "title": "Filter Groups" + }, + "limit": { + "type": "string", + "description": "The limit.", + "title": "Limit" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "sorts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sorts.", + "title": "Sorts" + }, + "query": { + "type": "string", + "description": "The query.", + "title": "Query" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total.", + "title": "Total" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/communications/batch/update": { + "post": { + "summary": "Update batch of communications", + "description": "Updates a batch of communications.", + "operationId": "UpdateABatchOfCommunications", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/communications/batch/archive": { + "post": { + "summary": "Archive batch of communications", + "description": "Archives a batch of communications by ID.", + "operationId": "ArchiveABatchOfCommunicationsById", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/communications/batch/create": { + "post": { + "summary": "Create a batch of communications", + "description": "Creates a batch of communications.", + "operationId": "CreateABatchOfCommunications", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "title": "Inputs" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/communications/batch/read": { + "post": { + "summary": "Get batch of communications", + "description": "Retrieves a batch of communications by internal ID, or unique property values.", + "operationId": "ReadABatchOfCommunicationsByInternalIdOrUniquePropertyValues", + "parameters": [ + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + } + }, + "title": "Inputs" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "propertiesWithHistory": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties with history.", + "title": "Properties With History" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "207": { + "description": "207", + "schema": { + "type": "object", + "properties": { + "completedAt": { + "type": "string", + "description": "When completed at.", + "title": "Completed At" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "startedAt": { + "type": "string", + "description": "When started at.", + "title": "Started At" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "numErrors": { + "type": "integer", + "format": "int32", + "description": "The number of errors.", + "title": "Errors" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "subCategory": { + "type": "object", + "properties": {}, + "description": "The sub category object.", + "title": "Sub Category" + } + } + }, + "title": "Errors" + }, + "requestedAt": { + "type": "string", + "description": "When requested at.", + "title": "Requested At" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/communications": { + "get": { + "summary": "List communications", + "description": "Retrieves a page of communications. Control what is returned via the `properties` query param.", + "operationId": "ListCommunications", + "parameters": [ + { + "name": "limit", + "default": 10, + "in": "query", + "x-ms-summary": "Limit", + "description": "The limit.", + "type": "integer", + "format": "int32", + "required": false + }, + { + "name": "after", + "in": "query", + "x-ms-summary": "After", + "description": "The after.", + "type": "string", + "required": false + }, + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + }, + "title": "Results" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ListCommunications", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "post": { + "summary": "Create communication", + "description": "Creates a communication with the given properties and return a copy of the object, including the ID.", + "operationId": "CreateCoomunication", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "associations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + } + }, + "title": "To" + }, + "types": { + "type": "array", + "items": { + "type": "object", + "properties": { + "associationCategory": { + "type": "string", + "description": "The association category.", + "title": "Association Category" + }, + "associationTypeId": { + "type": "string", + "description": "The association type identifier.", + "title": "Association Type ID" + } + } + }, + "title": "Types" + } + } + }, + "title": "Associations" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "201": { + "description": "201", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "CreateCommunication", + "x-ms-require-user-confirmation": true + } + ] + } + } + }, + "/crm/v3/objects/communications/{communicationId}": { + "get": { + "summary": "Get communication", + "description": "Retrieves an object identified by 'communicationId'. 'communicationId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId": "ReadCommunication", + "parameters": [ + { + "name": "properties", + "in": "query", + "x-ms-summary": "Properties", + "description": "The properties.", + "type": "string", + "required": false + }, + { + "name": "propertiesWithHistory", + "in": "query", + "x-ms-summary": "Properties with History", + "description": "The properties with history.", + "type": "string", + "required": false + }, + { + "name": "associations", + "in": "query", + "x-ms-summary": "Associations", + "description": "The associations.", + "type": "string", + "required": false + }, + { + "name": "archived", + "default": false, + "in": "query", + "x-ms-summary": "Archived", + "description": "Whether archived.", + "type": "boolean", + "required": false + }, + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "communicationId", + "in": "path", + "x-ms-summary": "Communication ID", + "x-ms-url-encoding": "single", + "description": "The communication identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + }, + "associations": { + "type": "object", + "properties": {}, + "description": "The associations object.", + "title": "Associations" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + }, + "x-ms-openai-data": { + "openai-enabled": true, + "operations": [ + { + "operationId": "ReadCommunication", + "x-ms-require-user-confirmation": false + } + ] + } + }, + "delete": { + "summary": "Archive communication", + "description": "Moves an object identified by 'communicationId' to the recycling bin.", + "operationId": "Archive79", + "parameters": [ + { + "name": "communicationId", + "in": "path", + "x-ms-summary": "Communication ID", + "x-ms-url-encoding": "single", + "description": "The communication identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + }, + "patch": { + "summary": "Update communication", + "description": "Performs a partial update of an object identified by 'communicationId'. 'communicationId' refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "Update80", + "parameters": [ + { + "name": "idProperty", + "in": "query", + "x-ms-summary": "ID Property", + "description": "The identifier property.", + "type": "string", + "required": false + }, + { + "name": "communicationId", + "in": "path", + "x-ms-summary": "Communication ID", + "x-ms-url-encoding": "single", + "description": "The communication identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/communications/merge": { + "post": { + "summary": "Merge two communications", + "description": "Merges two communications with same type.", + "operationId": "MergeTwoCommunicationsWithSameType", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectIdToMerge": { + "type": "string", + "description": "The object identifier to merge.", + "title": "Object ID To Merge" + }, + "primaryObjectId": { + "type": "string", + "description": "The primary object identifier.", + "title": "Primary Object ID" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/communications/gdpr-delete": { + "post": { + "summary": "Delete a communication - GDPR", + "description": "Permanently deletes a communication and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.", + "operationId": "GdprDelete82", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "The object identifier.", + "title": "Object ID" + }, + "idProperty": { + "type": "string", + "description": "The identifier property.", + "title": "ID Property" + } + } + }, + "required": true + } + ], + "responses": { + "204": { + "description": "204", + "schema": { + "type": "string" + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + }, + "/crm/v3/objects/communications/search": { + "post": { + "summary": "Search communications", + "description": "Retrieve a list of communications.", + "operationId": "Post-_crm_v3_objects_communications_search", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "filterGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "operator": { + "type": "string", + "description": "The operator.", + "title": "Operator" + }, + "propertyName": { + "type": "string", + "description": "The property name.", + "title": "Property Name" + }, + "value": { + "type": "string", + "description": "The value.", + "title": "Value" + }, + "highValue": { + "type": "string", + "description": "The high value.", + "title": "High Value" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The values.", + "title": "Values" + } + } + }, + "title": "Filters" + } + } + }, + "title": "Filter Groups" + }, + "limit": { + "type": "string", + "description": "The limit.", + "title": "Limit" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The properties.", + "title": "Properties" + }, + "sorts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The sorts.", + "title": "Sorts" + }, + "query": { + "type": "string", + "description": "The query.", + "title": "Query" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "id": { + "type": "string", + "description": "The identifier.", + "title": "ID" + }, + "properties": { + "type": "object", + "properties": {}, + "description": "The properties object.", + "title": "Properties" + }, + "updatedAt": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "propertiesWithHistory": { + "type": "object", + "properties": {}, + "description": "The properties with history object.", + "title": "Properties With History" + }, + "archived": { + "type": "boolean", + "description": "Whether archived.", + "title": "Archived" + }, + "archivedAt": { + "type": "string", + "description": "When archived at.", + "title": "Archived At" + } + } + }, + "title": "Results" + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total.", + "title": "Total" + }, + "paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string", + "description": "The after.", + "title": "After" + }, + "link": { + "type": "string", + "description": "The link.", + "title": "Link" + } + }, + "title": "Next" + } + }, + "title": "Paging" + } + } + } + }, + "500": { + "description": "500", + "schema": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier.", + "title": "Correlation ID" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "subCategory": { + "type": "string", + "description": "The sub category.", + "title": "Sub Category" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "in": { + "type": "string", + "description": "The in string.", + "title": "In" + }, + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "subCategory": { + "type": "string", + "description": "The sub category object.", + "title": "Sub Category" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + } + } + }, + "title": "Errors" + }, + "context": { + "type": "object", + "properties": {}, + "description": "The context object.", + "title": "Context" + }, + "links": { + "type": "object", + "properties": {}, + "description": "The links object.", + "title": "Links" + } + } + } + } + } + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "API Key": [] + } + ], + "x-ms-openai-manifest": { + "humanName": "HubSpot Engagements", + "modelDescription": "This is a Copilot plugin for the HubSpot Engagements service.", + "contactEmail": "ttaylor@hitachisolutions.com" + }, + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://www.hubspot.com/products/crm" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://legal.hubspot.com/privacy-policy" + }, + { + "propertyName": "Categories", + "propertyValue": "Sales and CRM;Communication" + } + ] +} diff --git a/independent-publisher-connectors/HubSpot Engagements V2/apiProperties.json b/independent-publisher-connectors/HubSpot Engagements V2/apiProperties.json new file mode 100644 index 000000000..c4b460e86 --- /dev/null +++ b/independent-publisher-connectors/HubSpot Engagements V2/apiProperties.json @@ -0,0 +1,23 @@ +{ + "properties": { + "connectionParameters": { + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN')", + "description": "The Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN') for this api", + "tooltip": "Provide your Access Token (in the form 'Bearer YOUR_ACCESS_TOKEN')", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "HubSpot" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/HubSpot Engagements V2/readme.md b/independent-publisher-connectors/HubSpot Engagements V2/readme.md new file mode 100644 index 000000000..62018a492 --- /dev/null +++ b/independent-publisher-connectors/HubSpot Engagements V2/readme.md @@ -0,0 +1,183 @@ +# HubSpot Engagements V2 +HubSpot Engagements is used for keeping your CRM records up-to-date on any interactions that take place outside of HubSpot. Activity reporting in the CRM also feeds off of this data. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +You must have an account with [HubSpot](https://app.hubspot.com/signup-hubspot/crm) and be a Super Admin. + +## Obtaining Credentials +Once you are logged in to your account, go to Settings -> Account Setup -> Integrations -> Private Apps. You will need to create a private app and assign it only the scopes you will use actions for. Once your private app is created, you will have an access token in the Auth section of the private app. + +## Supported Operations +### Create batch of calls +Creates a batch of calls. +### Get batch of calls +Retrieves a batch of calls by internal ID, or unique property values. +### Update batch of calls +Updates a batch of calls. +### Archive batch of calls +Archives a batch of calls by ID. +### List calls +Retrieves a page of calls. Control what is returned via the `properties` query param. +### Create a call +Creates a call with the given properties and return a copy of the object, including the ID. +### Read an object +Retrieves an object identified by `callId`. `callId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. +### Archive an object +Moves an object identified by `callId` to the recycling bin. +### Update an object +Performs a partial update of an object identified by `callId`. `callId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. +### Merge two calls +Merges two calls with same type. +### Delete a call - GDPR +Permanently deletes a call and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. +### Search calls +Retrieves a list of calls. +### Create a batch of emails +Creates a batch of emails. +### Get batch of emails +Retrieves a batch of emails by internal ID, or unique property values. +### Archive batch of emails +Archives a batch of emails by ID. +### Update batch of emails +Updates a batch of emails. +### List emails +Retrieves a page of emails. Control what is returned via the `properties` query param. +### Create an email +Creates a email with the given properties and return a copy of the object, including the ID. +### Get email +Retrieves an object identified by `emailId`. `emailId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. +### Archive email +Moves an object identified by `emailId` to the recycling bin. +### Update email +Performs a partial update of an object identified by `emailId`. `emailId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. +### Merge two emails +Merges two emails with same type. +### Delete an email - GDPR +Permanently deletes an email and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. +### Search email +Retrieve a list of emails. +### Update batch of meetings +Updates a batch of meetings. +### Archive batch of meetings +Archives a batch of meetings by ID. +### Get batch of meetings +Retrieves a batch of meetings by internal ID, or unique property values. +### Create a batch of meetings +Creates a batch of meetings. +### Get meeting +Retrieves an object identified by `meetingId`. `meetingId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. +### Archive meeting +Moves an object identified by `meetingId` to the recycling bin. +### Update meeting +Performs a partial update of an object identified by `meetingId`. `meetingId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. +### List meetings +Retrieves a page of meetings. Control what is returned via the `properties` query param. +### Create meeting +Creates a meeting with the given properties and return a copy of the object, including the ID. +### Merge two meetings +Merges two meetings with same type. +### Delete a meeting - GDPR +Permanently deletes a meeting and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. +### Search meetings +Retrieve a list of meetings. +### Get batch of notes +Retrieves a batch of notes by internal ID, or unique property values. +### Archive batch of notes +Archives a batch of notes by ID. +### Update batch of notes +Updates a batch of notes. +### Create a batch of notes +Creates a batch of notes. +### List notes +Retrieves a page of notes. Control what is returned via the `properties` query param. +### Create note +Creates a note with the given properties and return a copy of the object, including the ID. +### Get note +Retrieves an object identified by `noteId`. `noteId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. +### Archive note +Moves an object identified by `noteId` to the recycling bin. +### Update note +Performs a partial update of an object identified by `noteId`. `noteId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. +### Merge two notes +Merges two notes with same type. +### Delete a note - GDPR +Permanently deletes a note and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. +### Search notes +Retrieves a list of notes. +### Get batch of postal mail +Retrieves a batch of postal mail by internal ID, or unique property values. +### Archive batch of postal mail +Archives a batch of postal mail by ID. +### Create a batch of postal mail +Creates a batch of postal mail. +### Update batch of postal mail +Updates a batch of postal mail. +### List postal mail +Retrieves a page of postal mail. Control what is returned via the `properties` query param. +### Create postal mail +Creates a postal mail with the given properties and return a copy of the object, including the ID. +### Get postal mail +Retrieves an object identified by `postalMailId`. `postalMailId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. +### Archive postal mail +Moves an object identified by `postalMailId` to the recycling bin. +### Update postal mail +Performs a partial update of an object identified by `postalMailId`. `postalMailId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. +### Merge two postal mail +Merges two postal mail with same type. +### Delete a postal mail - GDPR +Permanently deletes a postal mail and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. +### Search postal mail +Retrieve a list of postal mail. +### Archive batch of tasks +Archives a batch of tasks by ID. +### Create a batch of tasks +Creates a batch of tasks. +### Update batch of tasks +Updates a batch of tasks. +### Get batch of tasks +Retrieves a batch of tasks by internal ID, or unique property values. +### Get task +Retrieves an object identified by `taskId`. `taskId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. +### Archive task +Moves an object identified by `taskId` to the recycling bin. +### Update task +Performs a partial update of an object identified by `taskId`. `taskId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. +### List tasks +Retrieves a page of tasks. Control what is returned via the `properties` query param. +### Create task +Creates a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided. +### Merge two tasks +Merges two tasks with same type. +### Delete a task - GDPR +Permanently deletes a task and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. +### Search tasks +Retrieve a list of tasks. +### Update batch of communications +Updates a batch of communications. +### Archive batch of communications +Archives a batch of communications by ID. +### Create a batch of communications +Creates a batch of communications. +### Get batch of communications +Retrieves a batch of communications by internal ID, or unique property values. +### List communications +Retrieves a page of communications. Control what is returned via the `properties` query param. +### Create communication +Creates a communication with the given properties and return a copy of the object, including the ID. +### Get communication +Retrieves an object identified by `communicationId`. `communicationId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. +### Archive communication +Moves an object identified by `communicationId` to the recycling bin. +### Update communication +Performs a partial update of an object identified by `communicationId`. `communicationId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. +### Merge two communications +Merges two communications with same type. +### Delete a communication - GDPR +Permanently deletes a communication and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. +### Search communications +Retrieve a list of communications. + +## Known Issues and Limitations +There are no known issues at this time.