Skip to main content
POST
/
engagements
/
v1
/
engagements
Create an engagement
curl --request POST \
  --url https://api.hubapi.com/engagements/v1/engagements \
  --header 'Content-Type: application/json' \
  --data '
{
  "engagement": {
    "type": "EMAIL",
    "active": true,
    "ownerId": 123,
    "timestamp": 123
  },
  "associations": {
    "contactIds": [
      123
    ],
    "companyIds": [
      123
    ],
    "dealIds": [
      123
    ],
    "ownerIds": [
      123
    ],
    "ticketIds": [
      123
    ]
  },
  "attachments": [
    {
      "id": 123
    }
  ],
  "metadata": {}
}
'
{
  "engagement": {},
  "associations": {},
  "attachments": [
    {}
  ],
  "metadata": {}
}

Body

application/json
engagement
object
required
associations
object
attachments
object[]

Optional list of file IDs, corresponding to IDs you get for files from the CMS Files API.

metadata
object

An object representing the details of the engagement. Format varies by engagement type - see documentation for specific formats for EMAIL, CALL, MEETING, TASK, and NOTE types.

Response

200 - application/json

Successful response - Engagement created successfully

engagement
object
associations
object
attachments
object[]
metadata
object