For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get SupportGet a demo
  • Get Started
    • Welcome
    • Quickstart
  • Webhooks
    • Introduction
    • Creating a Webhook
    • Available Webhooks
  • Public API Reference (Beta)
    • Applicants/Candidates
    • Contacts/Managers
    • Clients/Departments
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
        • GETGet a list of User Activities
        • GETGet a User Activity
        • POSTPersist an Activity
        • POSTPersist a Calendar Activity
        • DELDelete a User Activity
LogoLogo
Get SupportGet a demo
Internal API ReferenceActivitiesGeneral

Persist an Activity

POST
https://app.brightmove.com/ATS/app/activity
POST
/ATS/app/activity
$curl -X POST https://app.brightmove.com/ATS/app/activity \
>     -H "Content-Type: application/json" \
>     -d '{}'
200Successful
1{}
This will save a new activity if guid is not passed or update an existing activity that matches the guid.
Was this page helpful?
Previous

Persist a Calendar Activity

Next
Built with

Headers

X-Brightmove-Company-ApiKeystringOptional
X-Brightmove-User-ApiKeystringOptional

Request

This endpoint expects an object.
activityGklongOptional
parentActivityGklongOptional
activityDatedatetimeOptional
activityEndDatedatetimeOptional
activityFollowUpDatedatetimeOptional
activityFollowUpEndDatedatetimeOptional
activityTypestringOptional
activityTypeIdlongOptional
activityTypeBackgroundColorstringOptional
activityTypeBorderColorstringOptional
activityTypeTextColorstringOptional
activityUserNamestringOptional
activityTypeSyncbooleanOptional
followUpActivityTypeIdlongOptional
clientstringOptional
officestringOptional
officeGklongOptional
clientGklongOptional
opportunityGklongOptional
offsetlongOptional
applyToStartbooleanOptional
setFollowUpbooleanOptional
extApplicationIdintegerOptional
extApplicationKeystringOptional
createUserobjectOptional
modifyUserobjectOptional
createDatedatetimeOptional
modifyDatedatetimeOptional
activityCommentstringOptional
followUpActivityCommentstringOptional
guidstringOptional
activityUserobjectOptional
activityUserslist of longsOptional
clientGuidstringOptional
entityTypeenumOptional
activityUserGklongOptional
reqGklongOptional
contactslist of objectsOptional
canDeletebooleanOptional
canEditbooleanOptional
ownerbooleanOptional
allDaybooleanOptional
allDayFollowUpbooleanOptional
reminderDatedatetimeOptional
followUpReminderDatedatetimeOptional
completedbooleanOptional
completedDatedatetimeOptional
excludeWeekendsbooleanOptional
excludeWeekendsFollowupbooleanOptional
emailActivitybooleanOptional
followUpEmailActivitybooleanOptional
emailActivityResourcesbooleanOptional
overrideRecurrencebooleanOptional
activityRecurEndDatedatetimeOptional
workgroupslist of objectsOptional
recruiterslist of objectsOptional
frequencyCronExpressionstringOptional
submittalActivitybooleanOptional
displayAssignedResourcesstringOptional

Response

OK