Skip to main content
POST
Create a pipeline activity
A pipeline activity, such as a call, email, or meeting, associated with one or more companies, contacts, members, and opportunities.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
subject
string
required

The subject of the pipeline activity. Max 255 characters.

date
string<date>
required

The date of the pipeline activity. Will be in the form YYYY-MM-DD.

typeId
string
required

The uuid of the pipeline activity type.

content
string | null

The content or body of the pipeline activity. Max 5000 characters.

direction
enum<string> | null

Whether the activity was initiated by your team (outbound) or by the other party (inbound).

Available options:
inbound,
outbound
duration
integer | null

The duration of the pipeline activity in minutes.

memberIds
string[]

The uuids of the members to associate with this activity.

contactIds
string[]

The uuids of the contacts to associate with this activity.

companyIds
string[]

The uuids of the companies to associate with this activity.

opportunityIds
string[]

The uuids of the opportunities to associate with this activity.

Response

200

id
string

The unique identifier for the object.

subject
string

The subject of the pipeline activity.

content
string | null

The content or body of the pipeline activity.

direction
enum<string> | null

Whether the activity was initiated by your team (outbound) or by the other party (inbound).

Available options:
inbound,
outbound
date
string<date>

The date of the pipeline activity. Will be in the form YYYY-MM-DD.

duration
integer | null

The duration of the pipeline activity in minutes.

createdAt
string<date-time>

The timestamp when the object was created.

pipelineActivityType
object

The pipeline activity type associated with this activity.

members
object[]

The members associated with this activity.

contacts
object[]

The contacts associated with this activity.

companies
object[]

The companies associated with this activity.

opportunities
object[]

The opportunities associated with this activity.