Skip to main content
POST
Post a call

Authorizations

x-api-key
string
header
required

Body

application/json
externalId
string
required

The call id in your system. Posting it again returns the stored call instead of a second one.

Required string length: 1 - 200
direction
enum<string>
required

OUTBOUND when the salesperson placed the call, INBOUND when the lead did.

Available options:
OUTBOUND,
INBOUND
phone
string
required

The lead phone with its country code, e.g. 5548999998888. It finds the contact, or creates one.

Minimum string length: 1
userId
string
required

The project member who talked. Responsible for the contact and deal the call creates.

Minimum string length: 1
Pattern: ^[a-f\d]{24}$
startedAt
string<date-time>
required

ISO 8601 instant with an explicit offset, e.g. 2026-10-21T14:05:00-03:00.

endedAt
string<date-time>
required

ISO 8601 instant with an explicit offset, e.g. 2026-10-21T14:05:00-03:00.

outcome
enum<string>
required
Available options:
ANSWERED,
NO_ANSWER,
BUSY,
VOICEMAIL,
FAILED
recording
object
required

Required: a call is never stored without its audio.

answeredAt
string<date-time>

Absent when nobody answered. The talk time runs from here to endedAt.

dealId
string

Attaches the call to this deal. Without it the phone decides: the contact's open deal, or a new one.

Minimum string length: 1
Pattern: ^[a-f\d]{24}$
pipelineId
string

Where a deal the call creates starts. Send it with stageId; without both, the first open stage of the oldest pipeline.

Minimum string length: 1
Pattern: ^[a-f\d]{24}$
stageId
string

An open stage of pipelineId.

Minimum string length: 1

Response

Success

id
string
required
Minimum string length: 1
projectId
string
required
Minimum string length: 1
entityId
string
required

The deal the call is attached to, or the contact when it has no deal.

Minimum string length: 1
entityType
enum<string>
required
Available options:
DEAL,
CONTACT
provider
enum<string>
required

The telephony provider, or API for a call posted to POST /calls.

Available options:
API4COM,
API
externalId
string
required

The call id on the telephony provider, or in the system that posted it.

Minimum string length: 1
direction
enum<string>
required
Available options:
OUTBOUND,
INBOUND
from
object
required
to
object
required
startedAt
string<date-time>
required
endedAt
string<date-time>
required
durationInSeconds
integer
required

Talk time, from the answer to the hang up.

outcome
enum<string>
required
Available options:
ANSWERED,
NO_ANSWER,
BUSY,
VOICEMAIL,
FAILED
recording
object
required
transcription
object | null
required

Null while there is no stored recording.

analysis
object | null
required

The AI summary, written after each transcription; null before the first one.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
answeredAt
string<date-time>