Update Kit Assembly Task

Required permission: write_kit_assembly_tasks

Update an existing kit assembly task. At least one field must be provided.

Restrictions based on the task's current status:

  • quantity_to_assemble can only be updated while the task is unstaged.
  • completed: true can only be set while the task is staged.
  • completed: false reverts a completed task back to staged.

completed and assigned_user_id can only be updated with an organization API key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

The ID of the kit assembly task to update.

Body Params
integer | null
≥ 1

The new number of kits to assemble. Only allowed while the task is unstaged.

boolean | null

Set to true to complete a staged task, or false to revert a completed task back to staged.

integer | null
≥ 1

The ID of the organization user to assign the task to.

date-time | null

The date the task is due.

string | null

Additional instructions for the assembly team.

string | null

An optional reference number for the task.

tags
array of strings | null

Replaces all existing tags. Omit or pass null to leave tags unchanged; pass an empty array to remove all tags.

tags
integer | null
1 to 3

The priority of the task: 1 (low), 2 (medium), or 3 (high).

boolean

Whether the task's unassembled kits count toward the kit product's sell ahead (and its remaining components are held out of their available).

Responses

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