Change a template attachment with PATCH

PATCH/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}

v2Operation ID v2_public_message_template_internal_attachment_update_patch

Use PUT to change a template attachment. PATCH always fails with a server error.

Permission

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

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

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

  • Example DVubREua5aJkwh
• idstringrequired

  The attachment, from the template's attachment list. Its hash id from an earlier answer; there is no unique key for it.

  • Example 80qLp4P9l2ftvL

Request body

application/json, required.

• detailstring
• namestring
• optionsobject
  Child fields (1)

  • show_mockupboolean

    For so_jobs_with_mockup and so_jobs_without_mockup: true puts each job's mockup pages in the job sheets, false leaves them out. It overrides the type's own choice. Text such as "true" or "off" is accepted too; any other value is refused with 422 validation_failed. Other types ignore it.

Response

No success response is documented yet.

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.

• 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

  You called it with PATCH. The body is {"message": "Server Error"}, without the error envelope.

  Fix

  Use PUT.

Related

• GETGet a template attachment/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v2/api/store/your-team/setting/message_template/DVubREua5aJkwh/internal_attachment/80qLp4P9l2ftvL' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "name": "Order PDF"  }'