Skip to main content
POST
Apply a progress action

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Path Parameters

rootId
string<uuid>
required

Root of the tree the node belongs to.

id
string<uuid>
required

Record id.

Body

application/json

A progress action, keyed on type. Send this rather than patching the progress object directly.

type
enum<string>
required

complete finishes the remaining quantity. rework sends the node back. put-on-hold and resume-work toggle the hold.

Available options:
complete,
rework,
put-on-hold,
resume-work

Response

What the action changed.

The applied effect.