v4

latestOpenAPI 3.0.12026-07-13113471.2 KB

Basic

Create

Create a communication with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard communications is provided.

post/crm/objects/2026-09/{objectType}

Path parameters

objectTypestring required

The type of CRM object to query. Supported values include 'CONTACT' (0-1), 'TICKET' (0-5), 'DEAL' (0-3), 'COMPANY' (0-2), or custom object type IDs.

Request body

propertiesobject required

Key-value pairs for setting properties for the new object.

Response

successful operation

archivedboolean required

Whether the object is archived.

archivedAtstring date-time

The timestamp when the object was archived, in ISO 8601 format.

createdAtstring date-time required

The timestamp when the object was created, in ISO 8601 format.

idstring required

The unique ID of the object.

objectWriteTraceIdstring

An identifier used for tracing the write request for the object.

propertiesobject required

Key-value pairs representing the properties of the object.

propertiesWithHistoryobject

Key-value pairs representing the properties of the object along with their history.

updatedAtstring date-time required

The timestamp when the object was last updated, in ISO 8601 format.

urlstring

The URL associated with the object.