Skip to main content
POST
Stop work sessions

Authorizations

X-API-Key
string
header
required

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

Body

application/json

At least one of deliverableIds or workerIds is required.

deliverableIds
string<uuid>[]

Stop open sessions on these deliverables.

Deliverable id.

workerIds
string<uuid>[]

Stop open sessions for these people.

Person id.

sessionIds
string<uuid>[]

Stop these specific sessions.

Session id.

endDate
string<date-time>

When the sessions end. Defaults to now. A value earlier than a session's start collapses that session to zero duration rather than going negative.

Response

Stopped. The response has no body.