Email PayPal Pay Link
POST/api/paypal-payment-links/:id/email
Emails an active PayPal pay link to the customer using the editable "PayPal Payment Request" email template (sender, CC and BCC follow the account's outbound email settings).
Authentication: Requires Bearer token with permission to manage sales order payments.
Body fields:
recipient_email(string, optional) — address to email; defaults to the order's customer email.
The template's placeholders {{paypal_pay_link}}, {{amount_due}} and {{paypal_pay_link_expires_at}} are filled with the link's address, the order's amount due and the link's expiry date.
Returns 422 when the link is cancelled, paid or expired, when no address is available, or when the template is turned off; 404 when the link does not exist.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.