Create an activity (legacy path)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to create a new activity record. At least one parent ID (employerId, leadId, workflowId, customerId, meetingId) is required; if several are set, the first non-null in that order is used.

string
required

ID of the activity type (must exist in the caller's tenant)

string

Employer to log the activity against. Takes precedence over all other parent IDs; requires the employers:write permission.

string

Customer to log the activity against. Used only when employerId, leadId and workflowId are null; requires the customers:update permission.

string

Lead to log the activity against. Used only when employerId is null; requires the leads:update permission. The lead's customer is linked too.

string

Workflow to log the activity against. Used only when employerId and leadId are null; requires the workflows:update permission.

string

Meeting to log the activity against. Used only when all other parent IDs are null; requires the meetings:update permission.

jsonContent
object

Rich-text content of the activity as JSON (the editor's document model), stored alongside htmlContent

string
required
length ≥ 1

Activity content as HTML. Sanitized on save: formatting, blocks, styles, images, links and tables are kept, other markup is removed. Must not be blank.

mentions
array of objects, unique

Mentions present in the activity

mentions
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*