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 31, 2023

PUT /engagements/v1/engagements/:engagementId

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

HubSpot 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.

Note: This endpoint will replace any existing metadata with the contents of the request. To merge the contents of the request with the engagement's existing metadata, consider using the PATCH endpoint instead.

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.
metadata Included in request body You must include the metadata field when updating an engagement. Note: sending an empty metadata field will remove all details for the engagement.

Example URL to PUT 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.