HUhubspot
Advanced

Handle Inbound Call

Changed on

This endpoint processes inbound calls by accepting a request with details about the call. It requires a JSON payload containing information such as the call's external ID, final status, and phone numbers involved. This operation is useful for integrating third-party call data into HubSpot, allowing for seamless tracking and management of inbound calls.

post/crm/extensions/calling/2026-09/inbound-call

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/extensions/calling/2026-09/inbound-call
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.highly_sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.schemas.contacts.write

Request body

callStartedTimestampstring date-time

The date and time when the call started, in ISO 8601 format.

createEngagementboolean required

A boolean indicating whether an engagement should be created for this call.

durationSecondsinteger

The duration of the call in seconds, represented as an integer.

engagementPropertiesobject required

A map of custom property names to their values, used to store additional information about the engagement.

externalCallIdstring required

A unique identifier for the call provided by the external system.

finalCallStatus'BUSY' | 'CALLING_CRM_USER' | 'CANCELED' | 'COMPLETED' | 'CONNECTING' | 'FAILED' | 'HOLD' | 'IN_PROGRESS' | 'MISSED' | 'NO_ANSWER' | 'QUEUED' | 'RINGING' | 'UNKNOWN' required

The final status of the call. Valid values include 'QUEUED', 'RINGING', 'IN_PROGRESS', 'CANCELED', 'COMPLETED', 'BUSY', 'FAILED', 'NO_ANSWER', 'CONNECTING', 'CALLING_CRM_USER', 'MISSED', 'HOLD', and 'UNKNOWN'.

potentialRecipientUserIdsinteger[] required

An array of integers representing the user IDs of potential recipients of the call.

userIdinteger

The unique identifier of the user associated with the call. This is an integer.

Response

successful operation

Changes

  • 2026-09278a6bf84db7Revision changes
    • info

      the security scope crm.objects.contacts.highly_sensitive.write.v2 was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.schemas.contacts.write was removed from the endpoint's security scheme oauth2

  • 2026-09e9a241bb75d3Revision changes
    • info

      the security scope crm.objects.contacts.highly_sensitive.write.v2 was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.schemas.contacts.write was removed from the endpoint's security scheme oauth2