Skip to content
YoPrintDevelopers

Add a task to a job

Open .md

POST/v2/api/store/{team_slug}/v2/job/{hash_id}/work_pipeline

v2Operation ID v2_public_job_work_pipeline_store

Check success, not only the HTTP status: when the job's order is neither a draft nor published, this call answers HTTP 200 with { "status": 500, "success": false, "error": { "code": "action_not_allowed", "message": null } } and creates nothing.

Adds one task to a job and returns it.

A task comes from a task preset (Settings > Task Presets), which sets its statuses. Without status_id the task starts in the preset's first Pending status; without name it takes the preset's name.

Send start_date and due_date together (both may be null). A start after the due date is a 422 ("Invalid date range. Due Date should be greater than Start Date."). Changing a task's dates resets the job's dates to span its dated tasks: the earliest task start and the latest task due date (none when no task has dates).

Permission

Any member of the team. No sales order permission is checked.

Business rules

  • The job's order must be a draft or published; otherwise the reply is HTTP 200 with success: false and error.code action_not_allowed and nothing is created.
  • A task's status must be a status of its task preset. An unknown preset is a 422 "Pipeline not found!"; a status from another preset a 422 "Pipeline Status not found!".
  • Assigned users must be members of your team (404 otherwise).

Side effects

  • May change the job's start and due dates (see the description).
  • Open Admin Portal pages refresh. No one is notified of the assignment by email.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team
  • hash_idstringrequired

    The job's hash id (id). Hash ids only: a unique key or a document number gives 404.

    • Example WaGvtaWsx7Kcn4

Request body

application/json, required.

  • pipeline_idstringrequired

    The task preset (from List task presets). It sets the statuses and the default name. Required in practice: the server doesn't demand it, but without it (and without name) the call fails with 500, and with only name it creates a task that has no preset or status.

  • assigned_usersarray of strings

    User hash ids to assign. Send an array.

  • colorstring

    A hex color. Validated but not saved.

  • due_datestring (date-time) | null

    ISO 8601. Send with start_date.

  • namestring

    The task name. Defaults to the preset name.

  • notestring
  • positioninteger

    Order among the job's tasks.

    • Minimum -2147483648
    • Maximum 2147483647
  • start_datestring (date-time) | null

    ISO 8601. Send with due_date.

  • status_idstring

    A status of that preset. Defaults to the preset's first Pending status.

Response

200Successful response.

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

    When
    The job, or an assigned user, isn't your team's.
    Fix
    Check the ids.

  • 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

    When
    start_date or due_date sent without the other, or a field of the wrong type (validation_failed, details in error.fields).
    Fix
    Send both dates, or neither.
    When
    A start after the due date, an unknown preset, or a status from another preset (job_validation_error).
    Fix
    Send the dates in order and a status of the chosen preset.

  • 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

    When
    Neither pipeline_id nor name is sent.
    Fix
    Always send pipeline_id.

Notes

  • A refusal here is HTTP 200 with success: false and error.code action_not_allowed (the body's status says 500). A client that only checks the HTTP status will treat it as done.

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI specSupport: support@yoprint.comyoprint.com