Skip to main content
POST
Log a communication (call, email, SMS) on a deal, contact, or company

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Body

application/json
type
enum<string>
required
Available options:
call,
email,
sms,
whatsapp
direction
enum<string>
required
Available options:
inbound,
outbound
subject
string

Subject line (for emails)

body
string

Body/notes about the communication

durationSeconds
number

Duration in seconds (for calls)

Required range: x >= 0
outcome
enum<string>

Outcome (for calls)

Available options:
connected,
voicemail,
no_answer,
busy
occurredAt
string

When the communication occurred

externalId
string

External ID (email thread ID, etc.)

dealId
string

Deal ID to attach the communication to

contactId
string

Contact ID to attach the communication to

crmCompanyId
string

CRM Company ID to attach the communication to

Response

id
string
required
type
enum<string>
required
Available options:
call,
email,
sms,
whatsapp
direction
enum<string>
required
Available options:
inbound,
outbound
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
subject
string
body
string
durationSeconds
number
outcome
enum<string>
Available options:
connected,
voicemail,
no_answer,
busy
externalId
string
dealId
string
contactId
string
crmCompanyId
string
loggedById
string
loggedByName
string
occurredAt
string<date-time>