partially update one existing task

URL Expired

The URL for this request expired after 30 days.

Task Identifier

• identifier
  • uuid (required)
  • task unique identifier

Company UUID

• companyUuid
  • uuid (required)

Task Title

• title
  • string (required)

Task Description

• description
  • string

Task Type

• taskType
  • string
  • enum (required)
  • dataCollection,informationSharing,training,backgroundCheck,tinCheck,i9,w4,documentSigning,universal,partnerTask,video,internalDataReview,internal,ExternalAction,compliance

Sub Type

• subType
  • string
  • enum
  • Allowed:
    • default
    • iframe
    • webhook
    • workato
    • youtube

Estimated Completion Minutes

• estimatedCompletionMinutes
  • number

Content

• content
  • object

Require Review

• requireReview
  • boolean
  • true/false

Reuse in Rehire

• reuseInRehire
  • boolean
  • Defaults to true
  • When true (default), the task completion is carried over to the rehire profile. When false, the task starts incomplete in the rehire profile. Ignored for I-9, W-4, Background Check, and TIN Check tasks (always start incomplete).

Is Internal

• isInternal
  • boolean
  • true/false

Internal Task Data

• internalTaskData
  • object

API Request Example

curl --request PATCH \
     --url https://services.fountain.com/api/servicetodo/tasks/identifier \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "taskType": "dataCollection",
  "reuseInRehire": true
}
'  

Response Codes

• 202
• 500