APIs & Integrations

nina_pashinina
Member

Engagement API type "Call" property "metadata":"status"

Hello,

how can I list all values of the property "metadata":"status" for an engagement of type "CALL"?

ActivityLogCallStatus.PNG

Why the status "COMPLETED" is not in this list? Or can I write an arbitrary value in the "status" property? From the description https://developers.hubspot.com/docs/methods/engagements/create_engagement it's not clear which properties of "metadata" property are required and which are optional. If the values of some properties should be taken from the predefined lists or not?

"metadata" : {
   
"toNumber" : "5618769964",
   
// String; the phone number that was called
    "fromNumber" : "(857) 829-5489",
   
// String; the phone number that was used as the from number
    "status" : "COMPLETED",
   
// String; will be COMPLETED once the call is finished.

 

0 Upvotes
4 Replies 4
cbarley
HubSpot Alumni
HubSpot Alumni

Engagement API type "Call" property "metadata":"status"

Hi @nina_pashinina , those dropdown items refer to the calls "disposition". Normally, the status field will be set to COMPLETED since most calls logged to the CRM are after they've happened. To set the disposition of the call (whether it was the wrong number, busy, no answer, etc), You can make a GET to this endpoint, and set the disposition in the metadata of the request like so, when you eventually create the Call engagement:

 

"metadata" : {
    "status" : "COMPLETED",
    "body" : "Details go here"
    "disposition" : "73a0d17f-1163-4015-bdd5-ec830791da20"
}

 

0 Upvotes
OlaCarlander
Participant

Engagement API type "Call" property "metadata":"status"

Hi, 

 

How about this dropdown, type of a call. Any way to filter on that using the rest api? 

 

Capture.PNG

jeremyy7
Participant

Engagement API type "Call" property "metadata":"status"

Yeah, I'm looking for that as well!

0 Upvotes
dennisedson
HubSpot Product Team
HubSpot Product Team

Engagement API type "Call" property "metadata":"status"

@jeremyy7 , That is the activityType in the engagement object

Postman.png