Email a sent purchase order to the vendor again, to the recipients named

For a purchase order that was sent and is not cancelled (ordered, confirmed, shipped, arrived, receiving or received) and names a vendor: allowedActions offers email exactly then, and anything else is 409. It writes nothing on the purchase order: its version stays and the answer is 200 unchanged, with emailed. The email is sent once the request is done, the purchase order PDF attached. recipients names 1 to 20 people. The email goes To recipients (one address once, in the order given; absent on a send: the vendor contacts who get purchase orders), CC the user who sends it unless they are a recipient, and reply-to that user (the purchase order's creator when the caller is an API key). A recipient with saveAsContact: true needs a name and is saved to the vendor in the same request: a new contact who gets purchase orders, or the vendor's contact with that address switched to get them (and named when it has no name); 422 when the purchase order has no vendor. emailed answers who the email was addressed to and how many contacts were saved; it is absent when nobody was emailed. With an Idempotency-Key a retry answers the first response and sends no second email; every other request is a new email, also to the same people.

Scope: outgoing-purchase-orders:write, channel:write or admin. A permission group made before the Channel API scopes existed grants it as inventory:manage or supply-chain:manage.

Idempotency: send Idempotency-Key; a retry with the same key replays the first answer.

Rate limit: write class, 1,200 requests per minute per tenant by default (read class 6,000). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Path Params
string
required
length between 1 and 64

The purchase order's uuid or 24-hex id.

Body Params
recipients
array of objects
required
length between 1 and 20
recipients*
string
required
length between 3 and 255

An email address.

string
length ≤ 255
boolean

Also save them as a contact of the vendor who gets purchase orders by email (needs name). Default false.

Headers
string
length between 7 and 50

Any string of 7 to 50 characters that identifies this request (an order number, a webhook id). A retry with the same key and the same body answers the first result with Idempotent-Replayed: true; the same key with a different body is 422 idempotency_key_reused; a concurrent request with the same key is 409 in_progress with Retry-After. Recommended on every write.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json