Skip to content
YoPrintDevelopers

Edit a comment

Open .md

PUT/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}

v2Operation ID v2_public_order_comment_update

Meant to change a comment's text. Today it is refused for every order: a published order fails with "Permission Denied - The Resource is already created" and any other order with "No Permission - in mode: ...". Delete the comment and add a new one instead.

{hash_id2} is the comment's id. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Any member of the team.

Path parameters

  • team_slugstringrequired

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

    • Example your-team
  • hash_idstringrequired

    The sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

    • Example V4keXwwxMQyXw7
  • hash_id2stringrequired

    The comment's id (a hash id).

    • Example fFupqL9CYkMYgE

Request body

application/json, required.

Response

200Never sent today: every call is refused with 422.

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.

  • 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
    Always, as described above.
    Fix
    Delete the comment and add a new one.

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