Workflows
PATCH /workflows/{id}
PATCH operation for /workflows/{id}
patch/workflows/{id}
Path parameters
idstring required
Request body
idinteger
namestring required
workflow_type'quick_action' | 'event' | 'scheduled' required
workflow_actionsstring
workflow_actions_displaystring
trigger'map-created' | 'map-updated' | 'map-status-updated' | 'map-owner-updated' | 'map-task-created' | 'map-task-assignee-updated' | 'map-task-due-date-updated' | 'map-task-status-updated' | 'map-section-completed' | 'discussion-message-created' | 'customer-created' | 'customer-updated' | 'custom-form-submitted' | 'document-completed' | 'document-voided'
Only required when workflow_type=event
trigger_displaystring
internal_descriptionstring
created_atstring date-time
modified_atstring date-time
created_bystring
button_colorstring
button_placement'map' | 'map_task'
button_titlestring
is_enabledboolean
filtersobject
filters_rqlstring
workflow_eventsstring
is_hiddenboolean
schedule_type'daily' | 'weekly' | 'monthly'
schedule_dayinteger
Day of the week as an integer (0 for Monday, 6 for Sunday)
schedule_timestring time
Response
Successful response
idinteger
namestring required
workflow_type'quick_action' | 'event' | 'scheduled' required
workflow_actionsstring
workflow_actions_displaystring
trigger'map-created' | 'map-updated' | 'map-status-updated' | 'map-owner-updated' | 'map-task-created' | 'map-task-assignee-updated' | 'map-task-due-date-updated' | 'map-task-status-updated' | 'map-section-completed' | 'discussion-message-created' | 'customer-created' | 'customer-updated' | 'custom-form-submitted' | 'document-completed' | 'document-voided'
Only required when workflow_type=event
trigger_displaystring
internal_descriptionstring
created_atstring date-time
modified_atstring date-time
created_bystring
button_colorstring
button_placement'map' | 'map_task'
button_titlestring
is_enabledboolean
filtersobject
filters_rqlstring
workflow_eventsstring
is_hiddenboolean
schedule_type'daily' | 'weekly' | 'monthly'
schedule_dayinteger
Day of the week as an integer (0 for Monday, 6 for Sunday)
schedule_timestring time
Changes
No recorded changes to this endpoint across all 1 revision of this API.