There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Update an Engagement

Last updated May 15, 2023

PATCH /engagements/v1/engagements/:engagementId

Method Details

HTTP Methods:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

crm.objects.companies.write
crm.objects.contacts.write
crm.objects.deals.write
tickets
e-commerce

Update an engagement (a task or activity) on an object in HubSpot.

See the documentation for creating an engagement for more details on the fields that can be included.

Note: Associations cannot be modified using this endpoint. Use the CRM associations API to update associations for existing engagements.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Engagement JSON Included in request body An object representing the engagement you have created.

Example URL to PATCH to: https://api.hubapi.com/engagements/v1/engagements/74

Please see this page for more details about the data that can be used in engagements.