Skip to main content
PATCH
Update a destination

Authorizations

Authorization
string
header
required

Your secret key as a bearer token, e.g. Authorization: Bearer sk_live_…. Secret keys are server-side only.

Path Parameters

id
string
required

The destination id.

Query Parameters

dryRun
boolean
default:false

Validate and check references without saving: the response shows the record as it would be saved.

Body

application/json

Where a job's finished, print-ready files go once the job completes successfully. A destination is a reusable Library record: a workflow lists the destinations it delivers to in workflow.delivery.destinationIds (and only delivers while workflow.delivery.enabled is not false), and one destination can serve any number of workflows. kind picks the transport and params holds that transport's settings: email (download links mailed out), webhook (a JSON POST with download links, e.g. into Zapier), or one of the hotfolder kinds s3, sftp and ftp, which copy the files themselves into a folder the print shop's prepress or MIS system watches. Delivery runs once per job, after the job reaches done (never for previews or failed jobs); each destination is tried once and a failure on one does not stop the others. Files are named after the product (e.g. Business_Cards.pdf, or Business_Cards-1.pdf, Business_Cards-2.pdf when a job has several). Secret params (sftp/ftp password, sftp privateKey and passphrase, webhook headerValue) are write-only: send them as plain strings and they are encrypted on save; they read back masked as ********, and sending ******** back unchanged keeps the stored value. Use the destination test action to send a sample delivery (a one-page Sample_Product.pdf for order TEST-1001) through the real transport before pointing a workflow at it. Changing kind on an existing destination: also null out the old kind's params (JSON Merge Patch keeps keys you don't send).

kind
enum<string>
required

The transport. email: mails download links (no files attached) to an address, by default the shopper who placed the order. webhook: POSTs a JSON envelope with download links to a URL. s3: writes the files into an Amazon S3 bucket. sftp: uploads over SSH (SFTP). ftp: uploads over FTP or FTPS. s3, sftp and ftp are hotfolder kinds: they accept path tokens and metadata sidecars.

Available options:
email,
s3,
webhook,
sftp,
ftp
title
string

Display name in the dashboard and in delivery logs, e.g. "Prepress hotfolder (SFTP)". Optional; the dashboard falls back to the kind plus host, bucket or address.

Maximum string length: 200
description
string

A note for the print shop: what this destination feeds and who owns the receiving end.

Maximum string length: 1000
params
object
required if kind = s3 or kind = webhook or kind = sftp or …

The settings for kind; each kind accepts only its own keys. email: to, cc, bcc, replyTo, subject, attachMetadata, includeMetadata, templateId, linkExpiryHours. webhook: url (required), headerName, headerValue (secret), includeLinks, linkExpiryHours, meta. s3: bucket (required), region, access, roleArn, externalId, acl, prefix, plus the sidecar fields. sftp: host and username (required), port, password and/or privateKey (secrets, one required), passphrase (secret), path, plus the sidecar fields. ftp: host (required), port, username, password (secret), secure, path, plus the sidecar fields. Sidecar fields (s3/sftp/ftp): sidecar, sidecarFormat, sidecarTemplate, sidecarExt, includeFullReport.

secretsSet
object

Dashboard display flags saying which secret params hold a value (so the editor can show "set" without the secret). Not used for delivery and not authoritative; omit it, the dashboard derives it.

schemaVersion
integer

Record format version written by the dashboard editor (currently 1). Omit it.

Required range: x >= 1
tags
string[]

Free-form labels for organising the Library. Not used for delivery.

Maximum array length: 50
Required string length: 1 - 64

Response

OK

destination
Destination · object

Where a job's finished, print-ready files go once the job completes successfully. A destination is a reusable Library record: a workflow lists the destinations it delivers to in workflow.delivery.destinationIds (and only delivers while workflow.delivery.enabled is not false), and one destination can serve any number of workflows. kind picks the transport and params holds that transport's settings: email (download links mailed out), webhook (a JSON POST with download links, e.g. into Zapier), or one of the hotfolder kinds s3, sftp and ftp, which copy the files themselves into a folder the print shop's prepress or MIS system watches. Delivery runs once per job, after the job reaches done (never for previews or failed jobs); each destination is tried once and a failure on one does not stop the others. Files are named after the product (e.g. Business_Cards.pdf, or Business_Cards-1.pdf, Business_Cards-2.pdf when a job has several). Secret params (sftp/ftp password, sftp privateKey and passphrase, webhook headerValue) are write-only: send them as plain strings and they are encrypted on save; they read back masked as ********, and sending ******** back unchanged keeps the stored value. Use the destination test action to send a sample delivery (a one-page Sample_Product.pdf for order TEST-1001) through the real transport before pointing a workflow at it. Changing kind on an existing destination: also null out the old kind's params (JSON Merge Patch keeps keys you don't send).

dryRun
boolean

Present and true when nothing was saved.