Skip to content
New AI Custom Form BuilderDescribe the intake form. It ships branded and end-to-end encrypted.AI Custom Form Builder is here See it build
Engineering

API Updates for Adding and Removing Recipients

We’re pleased to announce three new endpoints for the SendSafely REST API, intended to facilitate more streamlined addition and removal of multiple recipients from SendSafely packages.

Brian Holyfield · 2 min read

We’re pleased to announce three new endpoints for the SendSafely REST API, intended to facilitate more streamlined addition and removal of multiple recipients from SendSafely packages.

Bulk Add Recipient

Bulk Add Recipient takes an array of packageIds as a body parameter, as well as the email address and–optionally, for SMS verification–the phone number and country code of your recipient. Previously, you had to add a recipient to one package at a time with the Add Recipient endpoint. With this new PUT endpoint, you can add one recipient to multiple packages in a single request.

Bulk Add Recipient is useful for integrated workflows, where you want to grant a support agent access to multiple packages in a single case or ticket.

Bulk Remove Recipient

Bulk Remove Recipient takes an array of packageIds as a body parameter, as well as the email address of your recipient. Previously, you had to remove a recipient from one package at a time with the Remove Recipient endpoint. This new DELETE endpoint enables you to remove one recipient from multiple packages in a single request.

Bulk Remove Recipient is useful for integrated workflows, where you want to revoke a support agent’s access to multiple packages in a single case or ticket, e.g., when they have been reassigned, or when the case or ticket is closed.

Delete Recipients

Delete Recipients takes a packageId as a path variable, and removes every recipient but the package owner (frequently, a No-Login Service Account) from that package. Previously, you had to remove one recipient at a time from a package with the Remove Recipient endpoint. This new DELETE endpoint enables you to remove all recipients (except the package owner) from a package in a single request.

Delete Recipients is useful for integrated workflows, where you want to revoke all support agents’ access to a package, e.g., when the case or ticket it pertains to is closed.

For more information on all of our REST API endpoints, consult our REST API documentation site.


SendSafely: Integrated File Transfer for the Apps you Love

If you are looking for a secure way to send or receive files with anyone, or simply need a better way to transfer large files, our platform might be right for you.

Request a Demo

Frequently asked questions

How do I add one recipient to multiple SendSafely packages with a single API call?

Use the Bulk Add Recipient PUT endpoint. It takes an array of packageIds and the recipient’s email address, plus an optional phone number and country code for SMS verification. See the Developer API.

How do I remove a recipient from multiple SendSafely packages at once?

Use the Bulk Remove Recipient DELETE endpoint, which takes an array of packageIds and the recipient’s email address. Previously you had to call Remove Recipient once per package.

How do I remove all recipients from a SendSafely package via the API?

Use the Delete Recipients DELETE endpoint with the packageId as a path variable. It removes every recipient except the package owner, which is frequently a No-Login Service Account.

When would I use the bulk recipient API endpoints?

They’re designed for integrated workflows, such as granting a support agent access to all packages on a case or ticket, or revoking agents’ access when a ticket is reassigned or closed.

Where can I find documentation for SendSafely's REST API?

SendSafely publishes its REST API endpoint documentation on its REST API documentation site, linked from the Developer API page.