Skip to main content
PUT
Push an activity

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Body

application/json
channel
enum<string>
required
Available options:
email,
linkedin,
call,
meeting,
webinar,
form,
web_visit,
event,
other
direction
enum<string>
required

outbound (to the person) or inbound (from them)

Available options:
inbound,
outbound
external_id
string
required

Your id for this touch

Required string length: 1 - 200
occurred_at
string<date-time>
required

When it happened, ISO 8601 (UTC when no offset); not in the future

person
TouchPerson · object
required
source
string
required

Your system's name, as the app shows it (HubSpot). With external_id, it identifies the touch

Required string length: 1 - 40
account
TouchAccount · object | null

Its account; left out, the person's account, else their email's domain

body_text
string | null

What was written, in plain text. Left out with messages: a conversation's words are its messages

Maximum string length: 32768
messages
TouchMessage · object[]

A conversation's messages (an email thread, a LinkedIn exchange): the whole thread or only its new messages, merged by each message's external_id. Left out for a single touch, and on any other channel

Maximum array length: 500
outcome
TouchOutcome · object | null
sent_by
string | null

The email of the teammate who sent it, when one did

Maximum string length: 320
subject
string | null
Maximum string length: 500
url
string | null

An https link to the touch in your system

Maximum string length: 2000

Response

Successful Response

accounts
string[]
required

The accounts whose timeline shows it; empty when none matched yet

id
string
required

The activity's id at GET /v1/activities/{activity_id}

person_id
string
required

The person it is with: found by email, or created

result
enum<string>
required

created; updated (a field changed, such as an email later opened); or unchanged (the same touch again: nothing was written)

Available options:
created,
updated,
unchanged