Update an Engagement

Last updated June 17, 2020

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:

contacts

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 API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
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?hapikey=demo

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