Postal Mail
Use the postal mail engagement API to log and manage postal mail on CRM records. You can log the mail you've sent or received in HubSpot or through the postal mail API. You can also retrieve, update, or delete existing postal mail engagements.
Below, learn the basic methods of managing postal mail through the API. To view all available endpoints and their requirements, click the Endpoints tab at the top of this article.
To create a postal mail engagement, make a POST
request to /crm/v3/objects/postal_mail
.
In the request body, add postal mail details in a properties object. You can also add an associations object to associate your new postal mail with an existing record (e.g., contacts, companies).
In the properties object, you can include the following fields:
Field | Description |
---|---|
hs_timestamp
| The date that the postal mail was sent or received. |
hs_postal_mail_body
| The body text of the postal mail engagement. |
hubspot_owner_id
| The ID of the user that created the postal mail engagement. |
hs_attachment_ids
| The IDs of any attachments to the postal mail engagement. Multiple attachment IDs are separated by a semi-colon. |
Parameter | Description |
---|---|
toObjectId
| The ID of the record that you want to associate the postal mail with. |
associationTypeId
| A unique identifier to indicate the association type between the postal mail and the other object. You can retrieve the value through the associations API. |
For example, to create postal mail and associate it with two contacts, your request body might look similar to the following:
You can retrieve postal mail engagements individually or in bulk.
To retrieve an individual postal mail engagement, make a GET
request to /crm/v3/objects/postal_mail/{postalMail}
. You can include the following parameters in the request:
Parameter | Description |
---|---|
properties
| A comma separated list of the properties to be returned. |
associations
| A comma separated list of object types to retrieve associated IDs for. Any specified associations that don't exist will not be returned in the response. Learn more about the associations API. |
To retrieve a list of the postal mail engagements in your account, make a GET
request to crm/v3/objects/postal_mail
. You can include the following parameters in the request:
Parameter | Description |
---|---|
limit
| The maximum number of results to display per page. |
properties
| A comma separated list of the properties to be returned. |
When you make a successful batch request, the response will include the ID of each postal mail engagement, which you can use to retrieve, update, and delete postal mail engagements.
You can update postal mail engagements individually or in batches. To update an individual engagement by its ID, make a PATCH
request to /crm/v3/objects/postal_mail/{postalMail}
.
In the request body, include the properties that you want to update. For example, to update the body of the engagement, your request body might look similar to the following:
HubSpot will ignore values for read-only and non-existent properties. To clear a property value, pass an empty string for the property in the request body.
Learn more about batch updating by clicking the Endpoints tab at the top of this article.
You can associate postal mail engagements with contact, company, deal, or ticket records. To associate postal mail with records, make a PUT
request to /crm/v3/objects/postal_mail/{postalMail}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Parameter | Description |
---|---|
postalMail
| The unique ID of the postal mail engagement. |
toObjectType
| The type of object that you want to associate the postal mail with (e.g., |
toObjectId
| The ID of the record that you want to associate the postal mail with. |
associationTypeId
| A unique identifier to indicate the association type between the postal mail and the other object. The ID can be represented numerically or in snake case (e.g., |
For example, your request URL might look similar to the following:
https://api.hubspot.com/crm/v3/objects/postal_mail/25727582880/associations/contact/104901/POSTAL_MAIL_TO_CONTACT
Remove an association
To remove an association between a postal mail engagement and a record, make a DELETE
request to:
/crm/v3/objects/postal_mail/{postalMail}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
You can delete a postal mail engagement individually or in bulk, which will add the engagement to the recycling bin in HubSpot. You can later restore the engagement from the record timeline.
To delete an individual postal mail engagement by its ID, make a DELETE
request to /crm/v3/objects/postal_mail/{postalMail}
.
Learn more about batch deleting postal mail engagements on the Endpoints tab at the top of this article.
Thank you for your feedback, it means a lot to us.