Projects

Create a project

Create a project: a job that owns a pool of jobs. A job created inside it takes the project's customer, brand and default location, and joins the pool unscheduled - it inherits no window, and only shows one once it is pinned to its own.

Projects never count toward job usage - only the jobs inside them meter.

crew_resource_ids attaches the engineers who may claim jobs from the pool; it needs the key creator to hold the jobs:assign capability.

Requires Idempotency-Key. Scopes: create:jobs and read:jobs (the project is read back in the response).

post/v1/projects

Request

  • Base URL: https://api.workwing.io
  • URL: https://api.workwing.io/v1/projects
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Unique per write, 1-256 printable ASCII characters. Retrying with the same key and the same request replays the original response for 24 hours. See Idempotency.

Request body

customer_idstring uuid required
titlestring

Optional name for the project, shown instead of its number.

brand_idstring uuid

Optional. Must match the API key's own brand when given.

location_idstring uuid
template_idstring uuid

Optional sign-off job type for the project itself.

scheduled_startstring date-time
scheduled_endstring date-time
priority'T_LOW' | 'T_NORMAL' | 'T_HIGH' | 'T_URGENT'
notesstring
crew_resource_idsstring[]

Response

Default Response

Changes

No recorded changes to this operation across all 1 revision of this API.