Update a status without checks

PATCH/v1/api/store/{team_slug}/setting/status/{status_reference}

v1Operation ID v1_public_status_update_patch

Use PUT to change a status. PATCH saves the fields without checking them, so a bad value can be stored. See Update a status (PUT) for the fields.

Permission

Needs the Manage Settings permission. The team owner always has it.

Business rules

• type and role can't change here. pipeline_id is ignored unless the status belongs to a task preset.

Side effects

• Team members who have YoPrint open see the change at once.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• status_referencestringrequired

  The status. Its hash id from an earlier answer; there is no unique key for it.

  • Example 0CoeFF1BmpcxxE

Request body

application/json, required.

• colorstring

  A hex color with the #, 3 or 6 digits: #1e88e5.

  • Matches ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
• customer_labelstring

  What customers see in the customer portal.

• labelstring
• pipeline_idstring

  For task statuses (role: pipeline) only: the task preset's ID. Moves this status to another task preset. Ignored for all other status roles.

• positioninteger
  • Minimum -2147483648
  • Maximum 2147483647

Response

200Successful response.

• dataobjectrequired
  Child fields (9)

  • colorstringrequired
  • customer_labelstringrequired

    What customers see in the customer portal. When none is set: Pending for start, In Progress for in_progress and pre_production, Completed for end.

  • idstringrequired
  • labelstringrequired
  • positionintegerrequired

    Sort order within the list, lowest first.

  • rolestringrequired

    Which list the status belongs to:

    • order: sales orders
    • quote: quotes
    • job: jobs
    • purchase_order: purchase orders
    • shipment: shipments
    • customer_message: message threads
    • pipeline: tasks within a task preset
    • One of: "order", "quote", "job", "purchase_order", "shipment", "customer_message", "pipeline"
  • trashedbooleanrequired

    True for a deleted status. Only the full list includes deleted ones.

  • typestringrequired

    The stage of the status in the workflow: start (first status in the list), pre_production, in_progress, or end (final status).

    • One of: "start", "pre_production", "in_progress", "end"
  • pipeline_idstring

    The task preset, for pipeline statuses only. Absent for every other role.

• statusintegerrequired
• successbooleanrequired

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.

  When

  Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.

  Fix

  Use the key of a member whose role has Manage Settings, or the owner's.

• 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

  No status of your team has this id. error.code is null; error.message names the record type.

  Fix

  Use an id from the status lists.

• 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

  color is not a hex color, or position is not a whole number (PUT only; validation_failed).

  Fix

  Send a color like #1e88e5 and an integer position.

Related

• GETGet a status/v1/api/store/{team_slug}/setting/status/{status_reference}
• POSTSave a set of status changes/v1/api/store/{team_slug}/setting/status/{status_reference}

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/setting/status/0CoeFF1BmpcxxE' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "color": "#3949ab",    "customer_label": "In production",    "label": "On press"  }'

Example response 200

Response

{
  "data": {
    "color": "#3949ab",
    "customer_label": "In production",
    "id": "0CoeFF1BmpcxxE",
    "label": "On press",
    "position": 2,
    "role": "order",
    "trashed": false,
    "type": "in_progress"
  },
  "status": 200,
  "success": true
}