Task

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

Overview

This endpoint automatically creates work assignments (to-dos) in the system that get assigned to specific users with due dates.

What it does:

  • Creates work items - Generates a task record that appears in a user's task list
    Assigns ownership - Designates a primary owner and optionally a backup owner to complete the work
  • Sets deadlines - Specifies when the task is due (can use relative dates like "+7 days" or "+2 weeks")
    Links to context - Attaches the task to the record that triggered it (claim, policy, etc.) so users have context
  • Supports recurring work - Can create tasks that repeat on a schedule (daily, weekly, monthly)

Potential Real-world use cases:
  • Claim review workflow: "Review new claim within 24 hours" - automatically assigns to adjuster when claim is created
  • Policy renewal reminder: "Contact insured 30 days before renewal" - task created 30 days before expiration date
  • Follow-up tracking: "Call customer back tomorrow at 2 PM" - creates task with specific due date and time
  • Recurring compliance: "Monthly audit of open claims" - generates task on 1st of every month
Path Params
string
required

Tasks can only be attached to domains where `HasTasks = true`.

When a domain supports tasks (`HasTasks = true`):

  • Task is created and linked to the parent record through ParentDomainID and ParentID
  • Task appears in the parent record's task list
  • Behavior works as expected

When a domain does not support tasks (`HasTasks = false`):

  • Task is still created as a standalone task
  • Task is not attached to the triggering record (no ParentDomainID or ParentID linkage)
  • Task exists in the system but is orphaned and not visible from the parent record

Special handling for Custom Entities:

Custom entities (client-defined domains) can specify a ParentTaskHost property that points to a related parent domain that supports tasks. In this case:

  • Task is attached to the configured parent domain instead
  • Example: A custom Review entity may attach tasks to its parent Claim
integer
required

This is the ID of the record where the task will be added.

Body Params
parameters
object
required
Response

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