Skip to content
YoPrintDevelopers

Add an attachment to a template

Open .md

POST/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment

v2Operation ID v2_public_message_template_internal_attachment_store

Adds an attachment to a message template. Document attachments, such as order, are made fresh from the record each time the template is sent; without a name they get a default such as Details {{order_number}}.pdf. A media attachment is a file you uploaded, by its media_id.

Attachment type values: order (the sales order or quote PDF), order_compact (its compact PDF), so_jobs_with_mockup and so_jobs_without_mockup (job sheets), so_invoices and so_compact_invoices (its invoices), purchase_order (the purchase order PDF), and media or reference_media (a file, by media_id). A template accepts only the values in its supported_attachments: purchase order templates take purchase_order, media and reference_media.

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

Request body

application/json, required.

  • typestringrequired

    What to attach. Must be in the template's supported_attachments.

    • One of: "order", "order_compact", "so_jobs_with_mockup", "so_jobs_without_mockup", "so_invoices", "so_compact_invoices", "purchase_order", "media", "reference_media"
  • detailstring
  • media_idstring

    Required for media: the id of a file you uploaded. reference_media also needs an existing file.

  • namestring

    A name for the attachment.

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

More examples (1)

An uploaded file

curl
curl -X POST 'https://secure.yoprint.com/v2/api/store/your-team/setting/message_template/DVubREua5aJkwh/internal_attachment' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "media_id": "ckQVnRGLx1GTIn",    "name": "Care instructions",    "type": "media"  }'

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
    No template of your team has this id. error.code is null; error.message names the record type.
    Fix
    Use a template id from the 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.

    When
    type is missing, or media_id is missing for media (validation_failed); the template doesn't support this type (type_not_supported); or the file is not found (media_not_found).
    Fix
    Use a type from the template's supported_attachments and an uploaded file's id.

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