Sign in
latestSwagger 2.02026-08-1766151238.8 KB

a444c5b1e78b

Activity

Creates a new activity (task/event/email/call)

post/api/activity

Request body

assignedToContactsGuidsstring[]

Used to set the reference in POST and PUTFor compatibility reasons, this will set/return an array of guids for the assigned to users instead of a list of UserRef objects. For compatibility reasons, this will set/return an array of guids for the assigned to users instead of a list of UserRef objects.

assignedToUsersGuidsstring[] required

Used to set the reference in POST and PUTFor compatibility reasons, this will set/return an array of guids for the assigned to users instead of a list of UserRef objects. For compatibility reasons, this will set/return an array of guids for the assigned to users instead of a list of UserRef objects.

completedByUserGuidstring uuid

Used to set the reference in POST and PUT

completedByContactGuidstring uuid

Used to set the reference in POST and PUT

tagNamesstring[]

For compatibility reasons, this will return an array of tag names instead of a list of tag objects.

lastModifiedDatestring date-time
callType'Inbound' | 'Outbound'
accountGuidstring uuid

Used to set the reference in POST and PUT

projectGuidstring uuid

Used to set the reference in POST and PUT

contactGuidstring uuid

Used to set the reference in POST and PUT

eventColorstring

Used to set the color of an activity of type 'event' on the calendar.

isSendNotificationEmailboolean required

If true, will send an email to the assignee with information about this activity.

isSendCompletedEmailboolean
saleDocumentGuidstring uuid

Used to set the reference in POST and PUT

workflowGuidstring uuid

Used to set the reference in POST and PUTIf this activity (of type 'task' or 'event') were created as part of a workflow, this will reference the workflow. If this activity (of type 'task' or 'event') were created as part of a workflow, this will reference the workflow.

numOfTimeEntriesinteger

Number of time entries related to this activity

numOfFlatFeesinteger
isConditionalboolean
activityConditionalTaskstring
numOfDueDateinteger
dueDateType'Days' | 'BusinessDays' | 'Weeks' | 'Months' | 'Years'
canCreateConditionalFromDetailsboolean
numberOfConditionalChildsinteger
isForSignatureRequestboolean
isCloneboolean
isPrivateboolean
descriptionstring
isDeletedboolean
createdDatestring date-time
lawToolboxCourtRule_Idstring uuid
dueDatestring date-time

Due date for activities of type tasks.

taskCompleteDatestring date-time
startDateTimestring date-time

Required for activities of type 'event'.

endDateTimestring date-time

Required for activities of type 'event'.

isAllDayActivityboolean

Required for activities of type 'event'.

locationstring
status'NotCompleted' | 'InProgress' | 'Completed' | 'Conditional'

Required for activities of type 'task'.

priority'Low' | 'Medium' | 'High'

Required for activities of type 'task'.

isOverdueboolean
hoursLoggednumber double
flatFeesLoggednumber double
isHoursLoggedManuallyboolean

sets if the activity should be marked as "time logged" even if no time was linked to it.

guidstring uuid
namestring required

Name (subject) of this activity.

type'Call' | 'Task' | 'Event' | 'Email' | 'Note' required

Sets the type of this activity (task/event/call/email)

Response

OK

assignedToContactsGuidsstring[]

Used to set the reference in POST and PUTFor compatibility reasons, this will set/return an array of guids for the assigned to users instead of a list of UserRef objects. For compatibility reasons, this will set/return an array of guids for the assigned to users instead of a list of UserRef objects.

assignedToUsersGuidsstring[] required

Used to set the reference in POST and PUTFor compatibility reasons, this will set/return an array of guids for the assigned to users instead of a list of UserRef objects. For compatibility reasons, this will set/return an array of guids for the assigned to users instead of a list of UserRef objects.

completedByUserGuidstring uuid

Used to set the reference in POST and PUT

completedByContactGuidstring uuid

Used to set the reference in POST and PUT

tagNamesstring[]

For compatibility reasons, this will return an array of tag names instead of a list of tag objects.

lastModifiedDatestring date-time
callType'Inbound' | 'Outbound'
accountGuidstring uuid

Used to set the reference in POST and PUT

projectGuidstring uuid

Used to set the reference in POST and PUT

contactGuidstring uuid

Used to set the reference in POST and PUT

eventColorstring

Used to set the color of an activity of type 'event' on the calendar.

isSendNotificationEmailboolean required

If true, will send an email to the assignee with information about this activity.

isSendCompletedEmailboolean
saleDocumentGuidstring uuid

Used to set the reference in POST and PUT

workflowGuidstring uuid

Used to set the reference in POST and PUTIf this activity (of type 'task' or 'event') were created as part of a workflow, this will reference the workflow. If this activity (of type 'task' or 'event') were created as part of a workflow, this will reference the workflow.

numOfTimeEntriesinteger

Number of time entries related to this activity

numOfFlatFeesinteger
isConditionalboolean
activityConditionalTaskstring
numOfDueDateinteger
dueDateType'Days' | 'BusinessDays' | 'Weeks' | 'Months' | 'Years'
canCreateConditionalFromDetailsboolean
numberOfConditionalChildsinteger
isForSignatureRequestboolean
isCloneboolean
isPrivateboolean
descriptionstring
isDeletedboolean
createdDatestring date-time
lawToolboxCourtRule_Idstring uuid
dueDatestring date-time

Due date for activities of type tasks.

taskCompleteDatestring date-time
startDateTimestring date-time

Required for activities of type 'event'.

endDateTimestring date-time

Required for activities of type 'event'.

isAllDayActivityboolean

Required for activities of type 'event'.

locationstring
status'NotCompleted' | 'InProgress' | 'Completed' | 'Conditional'

Required for activities of type 'task'.

priority'Low' | 'Medium' | 'High'

Required for activities of type 'task'.

isOverdueboolean
hoursLoggednumber double
flatFeesLoggednumber double
isHoursLoggedManuallyboolean

sets if the activity should be marked as "time logged" even if no time was linked to it.

guidstring uuid
namestring required

Name (subject) of this activity.

type'Call' | 'Task' | 'Event' | 'Email' | 'Note' required

Sets the type of this activity (task/event/call/email)