Change a job's status (retired)

PUT/v1/api/store/{team_slug}/job/{hash_id}/status

v1Legacy · deprecatedOperation ID v1_public_job_change_status

Legacy (deprecated)

A newer operation does this better.Use Change a job's status (PUT /v2/api/store/{team_slug}/v2/job/{hash_id}/status) instead.

Its answers say so in the Deprecation and X-YoPrint-Successor headers; see Deprecated operations.

Retired. This v1 route validates the body, then always fails with HTTP 500 and the bare body { "message": "Server Error" } (the deprecation text is not shown in production). Nothing changes. Use Change a job's status on the v2 API.

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.

• status_idstringrequired

  A job status hash id.

• notify_customerboolean | null

  Accepted and ignored.

Response

200Never sent: this retired route always fails with HTTP 500.

No response body.

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 id is not one of your team's hash ids (checked first).

  Fix

  Use the v2 route.

• 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

  status_id is missing or not a hash id.

  Fix

  Send a job status hash id.

• 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

  Always, after validation, as { "message": "Server Error" }. Nothing changes.

  Fix

  Call PUT /v2/job/{hash_id}/status instead.

Related

• PUTChange a job's status/v2/api/store/{team_slug}/v2/job/{hash_id}/status

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/job/WaGvtaWsx7Kcn4/status' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "status_id": "scaWHQnPLtqMPT"  }'

Example response 200

No response body.