Update a template attachment

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

v2Operation ID v2_public_message_template_internal_attachment_update_put

Changes an attachment's name, detail or options. options are merged into the saved ones. The type and file can't change: delete it and add a new one.

Use PUT. PATCH has no rules and fails with 500.

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

200Successful response.

• dataobjectrequired
  Child fields (13)

  • created_atstring (date-time)required
  • detailstring | nullrequired

    For a document attachment, defaults to its kind, such as Sales Order/Quote (PDF).

  • idstringrequired
  • mediaobject | nullrequired

    For a media or reference_media attachment, the file: id, name, file_name, mime_type, size, a download url, a signed view_url and more. Null for document attachments.

  • media_idstring | nullrequired
  • namestring | nullrequired
  • optionsstring | nullrequired

    The attachment's options as a JSON-encoded string, not an object: "[]", or for job sheets "{\"show_mockup\":true}". "null" for a media or reference_media file. Decode it before use.

  • order_idstring | nullrequired
  • order_scoped_idstring | integer | nullrequired
  • purchase_order_idstring | nullrequired
  • purchase_order_scoped_idstring | integer | nullrequired
  • typestringrequired
  • updated_atstring (date-time)required
• 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

  The template or the attachment is not found.

  Fix

  Use ids from the attachment list.

• 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.

Related

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

Example request

curl

curl -X PUT '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"  }'

Example response 200

Response

{
  "data": {
    "created_at": "2026-10-01T09:00:00+00:00",
    "detail": "Sales Order/Quote (PDF)",
    "id": "80qLp4P9l2ftvL",
    "media": null,
    "media_id": null,
    "name": "Order PDF",
    "options": "[]",
    "order_id": null,
    "order_scoped_id": "",
    "purchase_order_id": null,
    "purchase_order_scoped_id": "",
    "type": "order",
    "updated_at": "2026-11-03T10:00:00+00:00"
  },
  "status": 200,
  "success": true
}