HubSpot: Calling extensions schemas
7 HubSpot schemas with complete fields and constraints.
← Calling extensions operations · All schemas
Mark a call recording as ready for retrieval — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
engagementId | integer | Required within parent | The unique identifier for the engagement associated with the call recording. Format: int64 |
Submit details of an inbound call to the CRM — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
callStartedTimestamp | string | Optional | The timestamp indicating when the call started, formatted as a date-time string. Format: date-time |
createEngagement | boolean | Required within parent | Indicates whether an engagement should be created for the call. |
durationSeconds | integer | Optional | The duration of the call in seconds. Format: int32 |
engagementProperties | object | Required within parent | Contains additional properties related to the engagement. Additional keys: see wildcard field |
engagementProperties.* | string | Additional keys | |
externalCallId | string | Required within parent | The unique identifier for the call from an external system. |
finalCallStatus | string | Required within parent | The final status of the call, with accepted values including: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN. One of: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN |
fromNumber | Model | Required within parent | Expand Submit details of an inbound call to the CRM — request body — body to Number |
potentialRecipientUserIds | array | Required within parent | |
potentialRecipientUserIds[] | integer | Each item | Format: int32 |
toNumber | Model | Required within parent | Expand Submit details of an inbound call to the CRM — request body — body to Number |
userId | integer | Optional | The ID of the user associated with the call. Format: int32 |
Referenced models: Submit details of an inbound call to the CRM — request body — body to Number
Submit details of an inbound call to the CRM — request body — body to Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
e164Number | string | Required within parent | The phone number formatted in E.164 standard. |
extension | string | Optional | The extension number associated with the phone number. |
phoneNumberType | string | Required within parent | The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others. One of: FIXED_LINE, FIXED_LINE_OR_MOBILE, MOBILE, PAGER, PERSONAL_NUMBER, PREMIUM_RATE, SHARED_COST, TOLL_FREE, UAN, UNKNOWN, VOICEMAIL, VOIP |
Submit details of an inbound call to the CRM — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
callerIdMatches | array | Required within parent | |
callerIdMatches[] | JSON | Each item | |
callerIdMatches[] (anyOf 1) | Model | Alternative | Expand Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: CONTACT |
callerIdMatches[] (anyOf 2) | Model | Alternative | Expand Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: COMPANY |
Referenced models: Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: COMPANY, Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: CONTACT
Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: COMPANY
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
callerIdType | string | Required within parent | Specifies the type of caller ID, which is set to 'COMPANY' by default. Known values: COMPANY Default: COMPANY |
name | string | Optional | The name associated with the company caller ID. |
objectCoordinates | Model | Required within parent | Expand Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: COMPANY object Coordinates |
Referenced models: Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: COMPANY object Coordinates
Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: COMPANY object Coordinates
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
objectId | JSON | Required within parent | |
objectId (anyOf 1) | integer | Alternative | The unique identifier for the object. Format: int64 |
objectId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
objectTypeId | string | Required within parent | The type identifier for the object. |
portalId | JSON | Required within parent | |
portalId (anyOf 1) | integer | Alternative | The unique identifier for the portal. Format: int32 |
portalId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: CONTACT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
callerIdType | string | Required within parent | Specifies the type of caller ID, with the default value being CONTACT. Known values: CONTACT Default: CONTACT |
email | string | Optional | The email address of the contact. |
firstName | string | Optional | The first name of the contact. |
lastName | string | Optional | The last name of the contact. |
objectCoordinates | Model | Required within parent | Expand Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: COMPANY object Coordinates |
Referenced models: Submit details of an inbound call to the CRM. — response body — callerIdMatches / item / callerIdType: COMPANY object Coordinates