Authorizations
Body
Workflow name
1 - 255
Workflow definition
Workflow description
Whether the workflow is active
Start hour (0-23) for backward compatibility
0 <= x <= 23
End hour (0-23) for backward compatibility
0 <= x <= 23
Timezone for workflow execution and schedule interpretation
Workflow schedule - operates in workflow timezone defined above
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": { "enabled": false, "timeRanges": [] },
"sunday": { "enabled": false, "timeRanges": [] }
}
TCPA schedule - applies to borrower local timezone
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
}
Response
Agent workflow created successfully
Workflow ID
Workflow name
Workflow description
Organization ID
User ID who created the workflow
Whether the workflow is active
Start hour (0-23) for backward compatibility
End hour (0-23) for backward compatibility
Timezone for workflow execution and schedule interpretation
Workflow schedule - operates in workflow timezone
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": { "enabled": false, "timeRanges": [] },
"sunday": { "enabled": false, "timeRanges": [] }
}
TCPA schedule - applies to borrower local timezone
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
}
Workflow definition
Creation timestamp
Last update timestamp