Retrieve postal mail
Supported products
Supported products
Required Scopes
Required Scopes
Query Parameters
Whether to return only results that have been archived.
Body
Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
An array of SimplePublicObjectId objects, each containing the ID of an object to be read.
An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.
An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.
When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
Response
successful operation
A public object batch response object
The timestamp when the batch processing was completed, in ISO 8601 format.
An array of SimplePublicObject items representing the results of the batch operation.
The timestamp when the batch processing began, in ISO 8601 format.
The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"
CANCELED, COMPLETE, PENDING, PROCESSING A map of link names to associated URIs, providing additional information or actions related to the batch operation.
The timestamp when the batch request was initially made, in ISO 8601 format.