{"info":{"_postman_id":"7cc3df75-4708-4a43-8f87-4e98c06ccaea","name":"SendSafely REST API","description":"

SendSafely REST API. For more information visit developer.sendsafely.com.

\n

Pagination. The SendSafely Rest API uses the \"pageSize\" and “rowIndex\" parameters for endpoints that support pagination.

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19611653","collectionId":"7cc3df75-4708-4a43-8f87-4e98c06ccaea","publishedId":"2sBXwnuYCo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-06-01T15:40:14.000Z"},"item":[{"name":"package","item":[{"name":"{package Id}","item":[{"name":"recipient","item":[{"name":"{recipient Id}","item":[{"name":"Get Recipient","id":"a3afb8f2-1f64-49ae-892b-457c5a716d87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/","description":"

This endpoint returns the details for a specific recipient on a package.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"74a5781a-8a03-459b-bca3-f42186a1e6e3","type":"any","value":"","key":"packageId"},{"id":"ff828582-575a-4799-bac3-32cb35eae30a","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"84f1384c-71e4-4f52-a6fe-01a0db36b3d8","name":"Get Recipient Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvalRequired\": \"\", \"checkForPublicKeys\": \"\", \"recipientId\": \"\", \"email\": \"\", \"phonenumbers\": [ { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" }, { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" } ], \"fullName\": \"\", \"smsAuth\": \"\", \"isPackageOwner\": \"\", \"roleName\": \"\", \"response\": \"\"}"}],"_postman_id":"a3afb8f2-1f64-49ae-892b-457c5a716d87"},{"name":"Update Recipient","id":"59c6312a-6a18-4d0b-8f4a-a92e55133a61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"countrycode\": \"\", \"phoneNumber\": \"\", \"roleName\": \"\", \"workspaceNotificationPreference\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/","description":"

This endpoint updates the details for a specific recipient on a package.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"763fa384-d92d-4805-b0c0-20ac8dd87ac0","type":"any","value":"","key":"packageId"},{"id":"6d76040a-adfe-476e-999c-4b6efa9631c8","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"a273b98c-0294-4c8e-8c25-b13962ed5aa5","name":"Update Recipient Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"role\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvalRequired\": \"\", \"checkForPublicKeys\": \"\", \"recipientId\": \"\", \"email\": \"\", \"phonenumbers\": [ { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" }, { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" } ], \"fullName\": \"\", \"smsAuth\": \"\", \"isPackageOwner\": \"\", \"roleName\": \"\", \"response\": \"\"}"}],"_postman_id":"59c6312a-6a18-4d0b-8f4a-a92e55133a61"},{"name":"Remove Recipient","id":"3395bc4c-e99d-4369-bef3-6d02742d6c53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/","description":"

This endpoint removes a specific recipient from a package. If the recipient has already downloaded files from the package, they may be disabled instead.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"561123c3-7888-483b-9dae-fd4d308ca95d","type":"any","value":"","key":"packageId"},{"id":"02a6d554-bf7a-466b-a19e-4991cf3dbb7e","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"07997232-6265-46c9-baa8-6d5f1b8e7ef3","name":"Remove Recipient Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"3395bc4c-e99d-4369-bef3-6d02742d6c53"},{"name":"Get Recipient Public Keys","id":"9d580b0f-a6ce-43d5-800f-36b69ff3a4d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/:recipientId/public-keys/","description":"

This endpoint allows you to return the public keys related to a single recipient on the package.

\n","urlObject":{"path":["package",":packageId",":recipientId","public-keys",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"2a642857-c1d6-4040-bd37-246c3daf7575","type":"any","value":"","key":"packageId"},{"id":"3592b8e2-e4c8-4078-bee1-74578fc0b1ea","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"360d2fa2-b5f7-4cbb-b944-77c31e5cbf6a","name":"Get Recipient Public Keys Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package///public-keys/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"publicKeys\": [ { \"id\": \"\", \"key\": \"\" }, { \"id\": \"\", \"key\": \"\" } ], \"response\": \"\"}"}],"_postman_id":"9d580b0f-a6ce-43d5-800f-36b69ff3a4d4"},{"name":"Get Recipient Permissions","id":"6ef9a691-b50e-4050-8103-6d9654a16c6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/permissions/","description":"

This endpoint returns the list of permissions that have been granted to a specific recipient in a workspace.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"d54f8cb8-be30-4f7d-8ab3-8a543248df3e","type":"any","value":"","key":"packageId"},{"id":"6b43c63a-d1b3-4980-a061-b4f7b8a6b821","type":"any","value":"","key":"recipientId"}]}},"response":[],"_postman_id":"6ef9a691-b50e-4050-8103-6d9654a16c6c"}],"id":"dbd99501-2ffa-401f-956a-5bac498f6327","description":"

The Recipient ID is a unique identifier specific to one recipient on a single package.

\n","_postman_id":"dbd99501-2ffa-401f-956a-5bac498f6327"},{"name":"Add Recipient","id":"d48cfc2a-aaf2-4e6f-aa16-88cfe1a069f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"\", \"phoneNumber\": \"\", \"countryCode\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/","description":"

This endpoint adds a new recipient to a package.

\n","urlObject":{"path":["package",":packageId","recipient",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"ed13891f-b0b9-4215-8675-ea78775062dc","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"7d8d48ae-f178-4a96-b8d9-d1e23b88e27b","name":"Add Recipient Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvalRequired\": \"\", \"checkForPublicKeys\": \"\", \"recipientId\": \"\", \"email\": \"\", \"phonenumbers\": [ { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" }, { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" } ], \"fullName\": \"\", \"smsAuth\": \"\", \"isPackageOwner\": \"\", \"roleName\": \"\", \"response\": \"\"}"}],"_postman_id":"d48cfc2a-aaf2-4e6f-aa16-88cfe1a069f5"},{"name":"Add Recipients","id":"a22af895-43f9-4c2b-a2b9-40d8b17ccc9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"emails\": [\"\", \"\"], \"autoEnableSMS\": \"false\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipients/","description":"

This endpoint allows you to add multiple recipients to a single package at once.

\n","urlObject":{"path":["package",":packageId","recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"9cfff480-ffe5-4a9b-8b3e-adb0261044fd","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"6538fcfb-e3de-43b1-bae0-2091711e24b6","name":"Add Recipients Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["package",":packageId","recipient",""],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvalRequired\": \"\", \"recipients\": [ { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": {\"ipAddress\": \"\",\"timestamp\": \"\",\"timeStampStr\": \"\",\"isMessage\": \"\" }, \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\" }, { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": {\"ipAddress\": \"\",\"timestamp\": \"\",\"timeStampStr\": \"\",\"isMessage\": \"\" }, \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\" } ], \"response\": \"\"}"}],"_postman_id":"a22af895-43f9-4c2b-a2b9-40d8b17ccc9b"},{"name":"Delete Recipients","id":"e0887347-18a4-491f-a715-6096cc0d6619","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipients/","description":"

This endpoint allows you to delete all recipients from a single package at once.

\n","urlObject":{"path":["package",":packageId","recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"5f4ce81c-aa57-43b3-9cc0-948c8811d4f5","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"17c31087-007a-445f-825f-d63e919cf75e","name":"Delete Recipients Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipients/","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["package",":packageId","recipients",""],"variable":[{"key":"packageId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"\", \n \"response\":\"SUCCESS\", \n \"results\": \n {\n \"recipients\": [{\"email\": \"\"}], \n \"contactGroups\": [{\"groupName\": \"\", \"groupId\": \"\"}]\n }\n}"}],"_postman_id":"e0887347-18a4-491f-a715-6096cc0d6619"}],"id":"692982a7-92f4-4260-9e24-6ab55e5e8310","description":"

A recipient is an individual authorized by the package owner with permission to access a package.

\n","_postman_id":"692982a7-92f4-4260-9e24-6ab55e5e8310"},{"name":"file","item":[{"name":"{file Id}","item":[{"name":"Get File Upload Urls","id":"5bacf859-7f2d-4d19-9196-a8cf967cb8ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"part\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/upload-urls/","description":"

This endpoint returns the file part upload URLs for a file. Up to 25 file part URLs are returned at a time. To fetch the first set of URLs, either omit the \"offset\" parameter or set the offset value to 0.

\n","urlObject":{"path":["package",":packageId","file",":fileId","upload-urls",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"adbe4efc-0038-4e5d-a0b2-f3c4b8e84ddd","type":"any","value":"","key":"packageId"},{"id":"a341a051-f6a3-4e99-8dee-1427ac3562dd","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"16fab6dc-f765-474a-9bc5-500e2bfe8d72","name":"Get File Upload Urls Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"part\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file//upload-urls/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"uploadUrls\": [ { \"part\": \"\", \"url\": \"\" }, { \"part\": \"\", \"url\": \"\" } ]}"}],"_postman_id":"5bacf859-7f2d-4d19-9196-a8cf967cb8ce"},{"name":"Set File Upload Complete","id":"f9c0f20d-0c28-498d-9166-8789866dc003","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"directoryId\": \"\", \"complete\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/upload-complete/","description":"

This endpoint is used to sets the file upload status as complete. The server will verify that all of the required file parts are present within S3.

\n","urlObject":{"path":["package",":packageId","file",":fileId","upload-complete",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"5b006539-1a1b-4c0c-992b-9cabdc30215d","type":"any","value":"","key":"packageId"},{"id":"69fa3a7a-8b32-4b6f-bf7a-4a93d42ed341","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"a54fae26-9162-4539-ab89-dfe507e6507d","name":"Set File Upload Complete Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"complete\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file//upload-complete/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"f9c0f20d-0c28-498d-9166-8789866dc003"},{"name":"Get File Download Urls","id":"145b7abd-e5c7-4b4d-aad6-f829ace4e8ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"checksum\": \"\", \"startSegment\": \"\", \"endSegment\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/download-urls/","description":"

This endpoint returns the file part download URLs for a file. Up to 25 file part URLs are returned at a time. To fetch the first set of URLs, either omit the \"offset\" parameter or set the offset value to 0.

\n","urlObject":{"path":["package",":packageId","file",":fileId","download-urls",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"cb1d3b2b-4c77-42f9-bbb5-9cb999f1eb9f","type":"any","value":"","key":"packageId"},{"id":"bda82089-616e-4056-8f25-6ae290f8cc72","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"bd649a0b-db3b-4bc0-bc81-06a8f3d287d8","name":"Get File Download Urls Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file//download/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"145b7abd-e5c7-4b4d-aad6-f829ace4e8ba"},{"name":"Copy File To Workspace","id":"fd276070-1f98-4571-9141-b397e23fffcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"targetPackageId\": \"\",\"targetDirectoryId\": \"\",\"uploadType\": \"\",\"fileKey\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/copy/","description":"

This endpoint allows you to copy a file from a Transfer or Dropzone package into a SendSafely Workspace.

\n","urlObject":{"path":["package",":packageId","file",":fileId","copy",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"4e50f4b0-4000-4da5-8e41-c6966523eb87","type":"any","value":"","key":"packageId"},{"id":"a8691889-87d7-412d-a71e-d6b494cee267","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"e15be4b7-9323-4e0a-850c-2705a21d10cd","name":"Copy File To Workspace Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"targetPackageId\": \"\",\"targetDirectoryId\": \"\",\"uploadType\": \"\",\"fileKey\": \"\"}"},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/copy/","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["package",":packageId","file",":fileId","copy",""],"variable":[{"key":"packageId","value":""},{"key":"fileId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fd276070-1f98-4571-9141-b397e23fffcd"},{"name":"Update File","id":"ff81d544-5930-4e66-963e-aa924a96ceea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"body":{"mode":"raw","raw":"{\"fileName\": \"\", \"fileState\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/","description":"

This endpoint lets you update details for a specific file.

\n","urlObject":{"path":["package",":packageId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"1f019fb2-4988-428b-bee8-c43ea278aaca","type":"any","value":"","key":"packageId"},{"id":"5022d61f-1bed-49aa-8a49-8d1ff97ba643","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"f09e25a0-9eca-4cba-b28a-3a8291430341","name":"Update File Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0//directory//file//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"ff81d544-5930-4e66-963e-aa924a96ceea"},{"name":"Delete Package File","id":"23b7a04c-5ac4-475d-92cb-1567a2afbab7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/","description":"

This endpoint deletes a file from a draft package or from a Workspace.

\n","urlObject":{"path":["package",":packageId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"098fc4c5-127c-4def-96f2-ec627bae766a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"bee31177-071c-4c46-9bff-6e7245615335","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"2dabb281-e286-471f-ba6f-e90fb9302ded","name":"Delete Package File Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0//directory//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"23b7a04c-5ac4-475d-92cb-1567a2afbab7"},{"name":"Get File Information","id":"37ce5109-fda7-40c5-850f-68a4fb59c1e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/","description":"

This endpoint gets information about a particular file in a package.

\n","urlObject":{"path":["package",":packageId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"dbae2289-0910-4b78-b3ab-2f5c2612d526","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"c732318a-1941-4077-805e-4bd6845cadc5","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"6497df07-b9c7-4da1-97a1-deba46d99b05","name":"Get File Information Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//link//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"file\": {\n \"fileId\": \"\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"createdByEmail\": \"\",\n \"uploaded\": \"\",\n \"uploadedStr\": \"\",\n \"oldVersions\": [\n {\n \"fileId\": \"\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"createdByEmail\": \"\",\n \"uploaded\": \"\",\n \"uploadedStr\": \"\",\n \"fileVersion\": \"\",\n \"fileParts\": \"\"\n }\n ],\n \"fileParts\": \"\"\n },\n \"response\": \"\"\n}"}],"_postman_id":"37ce5109-fda7-40c5-850f-68a4fb59c1e2"}],"id":"51dc215f-aa42-49cc-81d8-119fe336fa76","description":"

The File ID is a unique identifier for an individual file on a package. Each version of a file (for Workspace files) has its own unique File ID.

\n","_postman_id":"51dc215f-aa42-49cc-81d8-119fe336fa76"},{"name":"Add File","id":"c8eb9a2a-481e-4580-a4ea-2213c3e6572a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"filename\": \"\",\"parts\": \"\",\"filesize\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/","description":"

This endpoint creates a new file within a package. You must specify the file name and file size along with the number of file parts that will be uploaded. A unique file id is returned.

\n","urlObject":{"path":["package",":packageId","file",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"5ca4ec64-b651-443d-8432-c7e9be77ecbb","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"324247f4-24d6-4e89-a37e-1955832bd8ea","name":"Add File Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"filename\": \"\",\"parts\": \"\",\"filesize\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"c8eb9a2a-481e-4580-a4ea-2213c3e6572a"}],"id":"759e3a09-2694-4efe-947f-d58fa6273eb1","description":"

A file stored in the root folder of the package. Subfolders are only available when using a Workspace (vdr) package.

\n","_postman_id":"759e3a09-2694-4efe-947f-d58fa6273eb1"},{"name":"link","item":[{"name":"{public key Id}","item":[{"name":"Get Keycode","id":"6ca21b70-e208-4ab2-b2ee-954f75cac198","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/link/:publicKeyId/","description":"

This endpoint returns the encrypted package keycode for a specific trusted device key.

\n","urlObject":{"path":["package",":packageId","link",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"cc515b9a-ddce-4abd-962f-cd9ab58539c5","type":"any","value":"","key":"packageId"},{"id":"66db940b-432d-4d4e-b4db-e795c07122d5","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"45a92bdc-5272-47ff-8f45-309ad0381540","name":"Get Keycode Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//link//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"message\": \"\", \"response\": \"\"}"}],"_postman_id":"6ca21b70-e208-4ab2-b2ee-954f75cac198"},{"name":"Add Keycode","id":"eb7f4c09-4ec5-4a99-8b0e-8c3acc748075","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"body":{"mode":"raw","raw":"{\"keycode\": \"\", \"notifyRecipients\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/link/:publicKeyId/","description":"

This endpoint lets you upload an encrypted keycode for a specific trusted device key.

\n","urlObject":{"path":["package",":packageId","link",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"909f2550-98db-4e79-b850-668043e845b0","type":"any","value":"","key":"packageId"},{"id":"80c17f26-db67-4475-bebf-847c8231558b","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"4802a556-d425-4c61-87d2-d25d3a493c7a","name":"Add Keycode Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//link//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"eb7f4c09-4ec5-4a99-8b0e-8c3acc748075"}],"id":"ed0d5242-eabd-4a1f-87df-6343dc5dad10","description":"

The unique identifier for a specific trusted browser public key.

\n","_postman_id":"ed0d5242-eabd-4a1f-87df-6343dc5dad10"}],"id":"7ffbe034-d301-41b2-8d3b-08e19f526125","description":"

For accessing items using a Trusted Device Key, the encrypted client-secret (keycode) must be uploaded for each trusted browser public key. The encrypted keycode is used to generate a \"keyed link\" when accessing the package.

\n","_postman_id":"7ffbe034-d301-41b2-8d3b-08e19f526125"},{"name":"directory","item":[{"name":"{directory Id}","item":[{"name":"permissions","item":[{"name":"Delete Directory Permission","id":"da257298-eb2a-4a85-ae57-429d97fb2b87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/directory/:directoryId/permissions/","description":"

This endpoint allows you to revoke permissions from a workspace directory for a specific recipient.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId","directory",":directoryId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"7564d467-3173-4752-8143-962b937180ac","type":"any","value":"","key":"packageId"},{"id":"e2468c70-5ecd-4a4d-ab37-6a3560c74a01","type":"any","value":"","key":"recipientId"},{"id":"bf3939ba-6817-4cd1-ae08-e2d14b70ba03","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"da257298-eb2a-4a85-ae57-429d97fb2b87"},{"name":"Add Directory Permission","id":"5a167cb7-a3b2-4dbc-93ab-1b3b74364045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"}],"body":{"mode":"raw","raw":"{\"recipientId\":\"\",\"role\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/permissions/","description":"

This endpoint allows you to grant permissions to a Workspace directory for a specific recipient.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"7cacb459-3ad0-4ad5-856c-01c297e97eef","type":"any","value":"","key":"packageId"},{"id":"0e0508c2-efc9-4010-acf5-77818ff35f4e","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"5a167cb7-a3b2-4dbc-93ab-1b3b74364045"},{"name":"Get Directory Permissions","id":"79d29b18-0b19-48a9-92be-6d5138bc3425","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/permissions/","description":"

This endpoint returns the list of permissions that have been granted to a workspace directory.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"1ba74fce-e219-462e-ae8a-88be6a0195f4","type":"any","value":"","key":"packageId"},{"id":"72525fef-9d49-47f2-a3e8-32a434e9088a","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"79d29b18-0b19-48a9-92be-6d5138bc3425"}],"id":"a90a955e-17ef-45e0-ba0a-5465fb40c075","description":"

Permissions are used to assign granular access to specific directories within a Workspace package.

\n","_postman_id":"a90a955e-17ef-45e0-ba0a-5465fb40c075"},{"name":"file","item":[{"name":"{file Id}","item":[{"name":"Get File Download Urls From Directory","id":"1add3cc2-6739-424c-b28c-50dbe474f07e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"checksum\": \"\", \"password\": \"\", \"startSegment\": \"\", \"endSegment\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/file/:fileId/download-urls/","description":"

This endpoint returns the file part download URLs for a file that resides within a specific directory (required for files inside of a SendSafely Workspace). Up to 25 file part URLs are returned at a time. To fetch the first set of URLs, either omit the \"offset\" parameter or set the offset value to 0.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","file",":fileId","download-urls",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"94d51ebc-e0e4-416a-b5a7-68cdee0a146e","type":"any","value":"","key":"packageId"},{"id":"b1d2b4b7-473b-4c98-bb91-19b18869c2c0","type":"any","value":"","key":"directoryId"},{"id":"ebcb5183-d8ac-49ba-9f05-d3e2ef5620fa","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"5849be21-b4f0-4c40-a765-d2122f75adf8","name":"Get File Download Urls from Directory Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file//download/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1add3cc2-6739-424c-b28c-50dbe474f07e"},{"name":"Delete File From Directory","id":"66d83072-9549-4d1d-8666-4f026439c090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/file/:fileId/","description":"

This endpoint lets you delete a file from a package directory. For Transfer and Dropzone packages, files can not be deleted once the package is finalized. For Workspace packages, files can be deleted at any time.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"5bd3c96e-dd52-4cd4-a779-c906fd969dab","type":"any","value":"","key":"packageId"},{"id":"1b31822f-2791-4282-a9ad-a1fdee5d2e57","type":"any","value":"","key":"directoryId"},{"id":"c4e8eb71-9346-48ea-9002-d12d7b3a8d8e","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"3ffbc117-4893-4ec0-95b4-7fe6abb39b0d","name":"Delete File From Directory Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0//directory//file//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"66d83072-9549-4d1d-8666-4f026439c090"},{"name":"Get File From Directory","id":"ae6e4670-6c2b-4bbe-b862-670c2fbea8ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/file/:fileId","description":"

This endpoint allows you to return the details for a specific file within a directory.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","file",":fileId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"3866fd7e-1eb7-4684-b125-1e572a2776bc","type":"any","value":"","key":"packageId"},{"id":"e07f181b-62c8-4d51-84ff-afed86419281","type":"any","value":"","key":"directoryId"},{"id":"deedbce2-8368-4e50-8a5b-be971fb4384c","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"a76d1142-d0d5-4018-b698-974e7e2ecdc2","name":"Get File From Directory Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory//file/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"file\": { \"file\": { \"fileId\": \"\", \"fileName\": \"\", \"fileSize\": \"\", \"createdByEmail\": \"\", \"uploaded\": \"\", \"uploadedStr\": \"\", \"oldVersions\": [{ \"fileId\": \"\", \"fileName\": \"\", \"fileSize\": \"\", \"createdByEmail\": \"\", \"uploaded\": \"\", \"uploadedStr\": \"\", \"fileParts\": \"\"},{ \"fileId\": \"\", \"fileName\": \"\", \"fileSize\": \"\", \"createdByEmail\": \"\", \"uploaded\": \"\", \"uploadedStr\": \"\", \"fileParts\": \"\"} ], \"fileParts\": \"\" } }, \"response\": \"\"}"}],"_postman_id":"ae6e4670-6c2b-4bbe-b862-670c2fbea8ed"}],"id":"60b051d2-dcbf-4539-9f61-242be4497417","description":"

The File ID is a unique identifier for an individual file on a package. Each version of a file (for Workspace files) has its own unique File ID.

\n","_postman_id":"60b051d2-dcbf-4539-9f61-242be4497417"}],"id":"9438dbe3-a918-47ad-ac28-7b994c1817dc","description":"

A file stored in the root folder of the package. Subfolders are only available when using a Workspace (vdr) package.

\n","_postman_id":"9438dbe3-a918-47ad-ac28-7b994c1817dc"},{"name":"Delete Directory","id":"1b68d7ec-f323-45d5-b6b2-44e30323a948","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/","description":"

This endpoint lets you delete a specific directory and its contents. This endpoint can only be used with a Workspace package.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"a796005d-9e7e-4912-b6ef-2856129d1c96","type":"any","value":"","key":"packageId"},{"id":"73a4ab5c-ac62-4f6e-95f7-503f65936533","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"00a67e97-65a6-4173-893b-932b37dd6701","name":"Delete Directory Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0//directory//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"1b68d7ec-f323-45d5-b6b2-44e30323a948"},{"name":"Get Directory","id":"28583ea4-e9a3-4749-84e9-8cf4ceac289a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId","description":"

This endpoint returns the list of items stored within a specific package directory.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"07fdfb10-4369-4703-b613-b979842cc817","type":"any","value":"","key":"packageId"},{"id":"a57c5d42-f090-4fab-b17a-c818905b85d5","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"ef2030af-b514-4f60-9289-1dee6078e216","name":"Get Directory Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"directoryName\": \"\", \"directoryId\": \"\", \"files\": [ \"\", \"\" ], \"subDirectories\": [ \"\", \"\" ], \"response\": \"\"}"}],"_postman_id":"28583ea4-e9a3-4749-84e9-8cf4ceac289a"},{"name":"Rename Directory","id":"2fcf1902-6adb-4ee3-86b4-0c80663fc00a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"body":{"mode":"raw","raw":"{\"directoryName\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId","description":"

This endpoint allows you to re-name a directory.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"01244861-5cf2-4ed1-8867-0de69f3350c1","type":"any","value":"","key":"packageId"},{"id":"90424869-c96f-4939-a577-af3034e369c0","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"8dcac6fb-24f0-4068-ba15-25db0bc0fe55","name":"Rename Directory Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"2fcf1902-6adb-4ee3-86b4-0c80663fc00a"},{"name":"Create Subdirectory","id":"810078c4-892a-4ebd-9668-675d1b9a310d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"directoryName\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/subdirectory/","description":"

This endpoint allows you to create a subdirectory within an existing package directory. Only Workspace packages support the option to add subdirectories.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","subdirectory",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"344fe61a-8e92-48fc-a2ef-41d769e2c9dd","type":"any","value":"","key":"packageId"},{"id":"861a794d-1502-4c68-8c4b-0609341ce839","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"6e13a972-426f-44d9-9987-63cae202551c","name":"Create Subdirectory Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"directoryName\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory//subdirectory/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"810078c4-892a-4ebd-9668-675d1b9a310d"},{"name":"Move Workspace File","id":"1f13c411-edb7-4a75-a011-d5248965e03c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/file/:fileId/","description":"

This endpoint moves a file from its current directory in a Workspace to the directory specified.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"b66feda1-a756-4583-842a-dfe03088c4c4","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"eb0261dd-7f56-457e-b953-0970353e5b32","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"directoryId"},{"id":"c21b7eb4-c8ff-4702-8314-025bc5e869a0","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"19a0e956-b2e0-4adb-bb97-0f9a77bfdf86","name":"Move Workspace File Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"1f13c411-edb7-4a75-a011-d5248965e03c"}],"id":"545a8455-a602-4f54-91da-5b0a90706010","description":"

The unique identifier for a specific directory (a folder or subfolder) within a Workspace package.

\n","_postman_id":"545a8455-a602-4f54-91da-5b0a90706010"}],"id":"abedac08-5ef0-4345-9a92-cce722c17bd3","description":"

A Directory represents a folder or subfolder within a Workspace package.

\n","_postman_id":"abedac08-5ef0-4345-9a92-cce722c17bd3"},{"name":"collaborator","item":[{"name":"Get Collaborators","id":"f1740e70-cecb-4792-b37c-36a200bfc996","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/collaborators","description":"

This endpoint returns the details for a specific recipient on a package.

\n","urlObject":{"path":["package",":packageId","collaborators"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"b4f13353-ddb7-470a-b0b5-45bb259bc320","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"be059216-9d1e-4920-86c8-7a949f948dd0","name":"Get Collaborators Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//collaborators"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"items\": [\n {\n \"type\": \"\",\n \"data\": {\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupOwnerId\": \"\",\n \"contactGroupIsOrganizationGroup\": \"\"\n }\n },\n {\n \"type\": \"\",\n \"data\": {\n \"recipientId\": \"\",\n \"fullName\": \"\",\n \"smsAuth\": \"\",\n \"email\": \"\",\n \"isGuest\": \"\",\n \"recipientAddFile\": \"\",\n \"recipientCanAddFileOnly\": \"\",\n \"recipientAddRecipient\": \"\",\n \"recipientRestricted\": \"\",\n \"recipientWorkspaceNotificationType\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"rowIndex\": \"\",\n \"rowsReturned\": \"\"\n },\n \"response\": \"\"\n}\n"}],"_postman_id":"f1740e70-cecb-4792-b37c-36a200bfc996"}],"id":"f136ba3f-4859-435c-adbc-b835a67c3573","_postman_id":"f136ba3f-4859-435c-adbc-b835a67c3573","description":""},{"name":"Get Package Information","id":"af256686-9bda-4986-a9e9-78f7ebd70671","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/","description":"

This endpoint returns detailed information for a specific package.

\n","urlObject":{"path":["package",":packageId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"dc4c7a42-b528-4db1-ac7c-1e79e8ad9f4c","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"911b7f0b-4f9d-42f3-8319-f480bd1b3cef","name":"Get Package Information Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"packageId\": \"\", \"packageCode\": \"\", \"serverSecret\": \"\", \"recipients\": [ { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": {\"ipAddress\": \"\",\"timestamp\": \"\",\"timeStampStr\": \"\",\"isMessage\": \"\" }, \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\" }, { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": {\"ipAddress\": \"\",\"timestamp\": \"\",\"timeStampStr\": \"\",\"isMessage\": \"\" }, \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\" } ], \"contactGroups\": [ { \"id\": \"\" }, { \"id\": \"\" } ], \"files\": [ { \"id\": \"\" }, { \"id\": \"\" } ], \"directories\": [ { \"id\": \"\" }, { \"id\": \"\" } ], \"approverList\": [ { \"null\": \"\" }, { \"null\": \"\" } ], \"needsApproval\": \"\", \"state\": \"\", \"passwordRequired\": \"\", \"life\": \"\", \"isVDR\": \"\", \"isArchived\": \"\", \"packageSender\": \"\", \"packageTimestamp\": \"\", \"rootDirectoryId\": \"\", \"response\": \"\"}"}],"_postman_id":"af256686-9bda-4986-a9e9-78f7ebd70671"},{"name":"Update Package","id":"57d74af5-653d-4bb0-be06-5de39dda483e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"life\": \"\", //The number of days from a package's creation after which it is set to expire.\n \"label\": \"\", //The label for the package. For Workspace packages, this is the Workspace name.\n \"checksum\": \"\", //The checksum for the package keycode.\n \"addWatermark\": \"\", //Whether to watermark PDF and image files in the package.\n \"maxAccessLimit\": \"\", //The number of times a package can be picked up by a given recipient before their access is revoked.\n \"pdfViewOnly\": \"\", //Whether recipients are restricted from downloading and printing PDF, image, and video files.\n \"packageMessageState\": \"\" //The message state of the package for use by Actions: null, block, or hold.\n}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/","description":"

This endpoint allows you to update properties of a package.

\n","urlObject":{"path":["package",":packageId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"65b2655f-b86a-4b39-bc3d-8bfc299077e0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"d559d1c9-5bc2-461d-b0f7-ba154a70b29d","name":"Update Package Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"label\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"57d74af5-653d-4bb0-be06-5de39dda483e"},{"name":"Delete Package","id":"28e30547-149c-4b5f-b8d9-67e67ba804b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/","description":"

This endpoint allows you to delete a package and all of its contents.

\n","urlObject":{"path":["package",":packageId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"be8930da-6625-4daa-924d-3c2c30adce73","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"dfed90a2-c332-423b-a870-8fd8c374a530","name":"Delete Package Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"28e30547-149c-4b5f-b8d9-67e67ba804b2"},{"name":"Finalize Package","id":"628a2c82-6b99-458e-b570-938bc2400c93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"password\": \"\", \"checksum\": \"\", \"undisclosedRecipients\": \"\", \"recaptchaToken\": \"\", \"readOnlyPdf\": \"\", \"unconfirmedSender\": \"\", \"confirmedSenderToken\": \"\", \"notifyRecipients\": \"\", \"allowReplyAll\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/finalize/","description":"

This endpoint allows you to mark a package as finalized, meaning that it will be available to all recipients. Once finalized, the contents of the package (files and messages) cannot be modified. Only Transfer and Dropzone packages can be finalized.

\n

The message property of the response contains the secure link for accessing the encrypted message. When sharing the link with a recipient, the client-side generated secret should be passed as the value of a keyCode parameter appended as a URL Fragment Identifier. For example: https://companyabc.sendsafely.com:8443/receive/?thread=AAAA-BBBB&packageCode=XXXXXXX#keyCode=XXXXYYYYY

\n","urlObject":{"path":["package",":packageId","finalize",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"7bcae911-3986-4967-a9cf-1376cab6d238","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"9316310d-5f04-41ec-8dac-41577477d103","name":"Finalize Package Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"checksum\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//finalize/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvers\": [ \"\", \"\" ], \"recipients\": [ \"\", \"\" ], \"needsLink\": \"\", \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"628a2c82-6b99-458e-b570-938bc2400c93"},{"name":"Add Encrypted Message","id":"eaf9f19d-45be-4161-bedf-39cf9efb3744","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"message\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/message/","description":"

This endpoint adds or replaces the encrypted message for a package. Each package can only include a single encrypted message.

\n

To encrypt the message, you will need to use an encryption library that implements the OpenPGP message format. Specifically, the following is required when encrypting with OpenPGP: The Symmetric-Key Algorithm should be 9 (AES-256)The Compression Algorithm should be 0 (Uncompressed)The Hash Algorithm should be 8 (SHA-256)The 256-bit encryption key is the package server secret concatenated with a random 256-bit secret generated client-side, which will be included as the \"keyCode\" parameter in the secure link.

\n","urlObject":{"path":["package",":packageId","message",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"468336c2-2c7e-4e83-a495-df79c5592de5","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"92fe6729-2823-4d2a-857e-05a33cf51add","name":"Add Encrypted Message Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"message\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//message/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"eaf9f19d-45be-4161-bedf-39cf9efb3744"},{"name":"Get Package Public Keys","id":"3cb97a65-7112-48b3-89ac-002fafb433bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/public-keys/","description":"

This endpoint returns the list of public keys associated with a package. The keycode for the package should be encrypted with each public key and uploaded using the Add Keycode endpoint.

\n","urlObject":{"path":["package",":packageId","public-keys",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"2494511e-fdbd-4f5d-b5c8-f33b1e193ae6","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"03a2993a-a167-492e-9f27-2d2598821b41","name":"Get Package Public Keys Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//public-keys/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"publicKeys\": [ { \"id\": \"\", \"key\": \"\" }, { \"id\": \"\", \"key\": \"\" } ], \"response\": \"\"}"}],"_postman_id":"3cb97a65-7112-48b3-89ac-002fafb433bb"},{"name":"Get Workspace Activity Log","id":"4edf8230-f334-40c9-ad4a-e40c1130c727","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"body":{"mode":"raw","raw":"{\"rowIndex\": \"\", \"targetId\": \"\", \"userId\": \"\", \"recipientId\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/activityLog/","description":"

This endpoint returns the activity log for a workspace package.

\n","urlObject":{"path":["package",":packageId","activityLog",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"db11d5aa-60d7-4d53-8dc2-14a62cf3e28d","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"9d397c95-b569-4109-a132-da421aefe101","name":"Get Workspace Activity Log Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//activityLog/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"activityLogEntries\": [ { \"activityLogId\": \"\", \"timestamp\": \"\", \"timestampStr\": \"\", \"ipAddress\": \"\", \"packageId\": \"\", \"targetId\": \"\", \"actionDescription\": \"\", \"action\": \"\", \"user\": {\"userEmail\": \"\",\"userId\": \"\" } }, { \"activityLogId\": \"\", \"timestamp\": \"\", \"timestampStr\": \"\", \"ipAddress\": \"\", \"packageId\": \"\", \"targetId\": \"\", \"actionDescription\": \"\", \"action\": \"\", \"user\": {\"userEmail\": \"\",\"userId\": \"\" } } ], \"response\": \"\"}"}],"_postman_id":"4edf8230-f334-40c9-ad4a-e40c1130c727"},{"name":"Move Directory","id":"56b715ce-54f6-40bb-b353-258d6a537db7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/move/:sourcedirectoryId/:targetdirectoryId/","description":"

This endpoint allows you to move the location of a specific directory within a package.

\n","urlObject":{"path":["package",":packageId","move",":sourcedirectoryId",":targetdirectoryId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"56214259-f36f-4a56-bdc2-ff7d2a61127c","type":"any","value":"","key":"packageId"},{"id":"767ee31e-6ab2-4e19-bd5c-20a929aa6cf4","type":"any","value":"","key":"sourcedirectoryId"},{"id":"06cac007-ca42-4d25-bca2-446215d97716","type":"any","value":"","key":"targetdirectoryId"}]}},"response":[{"id":"75271034-5ef6-4a80-872b-27348ae42a0d","name":"Move Directory Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//move///"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"56b715ce-54f6-40bb-b353-258d6a537db7"},{"name":"Get Package Permissions","id":"286521f2-d9dc-4ac7-b289-3a4f0f725393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/permissions/","description":"

This endpoint returns a list of all permissions that have been granted to recipients in a workspace.

\n","urlObject":{"path":["package",":packageId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"baa47358-5275-4ba2-9743-f7acb15b8099","type":"any","value":"","key":"packageId"}]}},"response":[],"_postman_id":"286521f2-d9dc-4ac7-b289-3a4f0f725393"},{"name":"Delete Contact Group from Package","id":"378da38a-561b-49a5-81b8-6167c0b648ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/group/:groupId/","description":"

This endpoint removes a contact group as a recipient from a package.

\n","urlObject":{"path":["package",":packageId","group",":groupId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"84f1eeb0-ab1f-4991-bbc5-eef1e9f9ddd4","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"3af9f894-27b2-4b95-9b6b-11bb41246b00","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"groupId"}]}},"response":[{"id":"c308d497-aacd-4800-a9d0-ceb2ebff9203","name":"Delete Contact Group from Package Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\"\n}"}],"_postman_id":"378da38a-561b-49a5-81b8-6167c0b648ec"},{"name":"Delete Temp Package","id":"8235d779-213f-410d-9b11-5c6c062b5545","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/temp/","description":"

This endpoint deletes a temporary package.

\n","urlObject":{"path":["package",":packageId","temp",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"ce98cb19-7eae-4f7c-9021-e24a70f73bfe","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"d57ab6ea-64b3-4019-a02f-a308fad98b80","name":"Delete Temp Package Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\"\n}"}],"_postman_id":"8235d779-213f-410d-9b11-5c6c062b5545"},{"name":"Add Contact Group to Package","id":"3f775ff8-3998-4beb-ae0e-3d0ecc3e464e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/group/:groupId/","description":"

This endpoint adds a contact group as a recipient to a package, so that the members of the contact group can access it.

\n","urlObject":{"path":["package",":packageId","group",":groupId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"ef521259-1171-4b3b-b4ac-62eb15ada8cb","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"a257661f-9a5d-4110-924b-de927f318bbf","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"groupId"}]}},"response":[{"id":"dad49fa4-d137-45e9-b82f-448cc429ce76","name":"Add Contact Group to Package Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group//user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupUserEmails\": [\n \"\",\n \"\"\n ],\n \"response\": \"\"\n}"}],"_postman_id":"3f775ff8-3998-4beb-ae0e-3d0ecc3e464e"},{"name":"Get Package Message","id":"8de89167-d60f-4812-912f-7b1ac58aa59e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/message/:checksum/","description":"

This endpoint returns a Base64-encoded version of the encrypted message, to decode and pass into PGP to decrypt.

\n","urlObject":{"path":["package",":packageId","message",":checksum",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"453fb3eb-39da-4d6c-9597-da7ecf24fe4b","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"37836001-9076-4d9c-bfa5-b54e78f4d0e1","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"checksum"}]}},"response":[{"id":"4a7ededf-7f1e-479c-a655-3b7bc6ad18ad","name":"Get Package Message Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"8de89167-d60f-4812-912f-7b1ac58aa59e"},{"name":"Bulk Package Transfer Ownership","id":"5c78fe8b-9212-4599-9b9f-5edbf80486fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"packageIds\":[\"packageId\"],\"newOwner\":\"email\",\"packageType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/transfer-ownership/","urlObject":{"path":["package","transfer-ownership",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"b639d2d5-e911-418a-8d08-127f6ea29602","name":"Bulk Package Transfer Ownership","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"packageIds\":[\"packageId\"],\"newOwner\":\"email\",\"isCapped\":\"boolean\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/transfer-ownership/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5c78fe8b-9212-4599-9b9f-5edbf80486fc"}],"id":"8bffc63b-64d5-4142-9c81-2469573fb94b","description":"

The Package ID is a unique identifier for a specific SendSafely package.

\n","_postman_id":"8bffc63b-64d5-4142-9c81-2469573fb94b"},{"name":"organization","item":[{"name":"Get Organization Packages [DEPRECATED]","id":"ea2064a4-2174-49d5-a93c-7f1c13baa340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/","description":"

This endpoint is deprecated, please use Organization Package Search instead.

\n","urlObject":{"path":["package","organization",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"e3b00028-1ea1-4363-a9cc-939fcfe8fd11","name":"Get Organization Packages [DEPRECATED] Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ea2064a4-2174-49d5-a93c-7f1c13baa340"},{"name":"Organization Package Search","id":"69bf7564-fcbc-4f7e-be7c-17f166e17686","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\",\"rowIndex\": \"\", \"pageSize\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/search","description":"

This endpoint returns packages in the current user's organization based on provided search criteria. The calling user must be a SendSafely Enterprise Administrator.

\n

The search defaults to returning all packages up to the current date and time, if a specific value is not passed for each search criteria. A maximum of 100 records will be returned per method call.

\n

This endpoint supports pagination.

\n","urlObject":{"path":["package","organization","search"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"32ed76f2-f09d-41aa-a0db-805156902fda","name":"Organization Package Search Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"69bf7564-fcbc-4f7e-be7c-17f166e17686"}],"id":"40d41a41-3753-422d-bdc1-0cbcec6754da","description":"

The enterprise organization that manages a specific SendSafely portal and all registered users within it.

\n","_postman_id":"40d41a41-3753-422d-bdc1-0cbcec6754da"},{"name":"Create Package","id":"1959ee4d-d17e-4096-84ae-7a188bebe8d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"vdr\": \"\", \"packageUserEmail\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/","description":"

This endpoint allows you to create a new package. Setting vdr to true makes the new package a Workspace.

\n

An enterprise admin can set packageUserEmail to create packages on behalf of another registered user in their portal.

\n","urlObject":{"path":["package",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"3308ed11-64b0-4e1e-8321-ddcbd78d9190","name":"Create Package Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"SendSafely API Key (API_KEY)"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"vdr\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"packageId\": \"\", \"packageCode\": \"\", \"serverSecret\": \"\", \"response\": \"\"}"}],"_postman_id":"1959ee4d-d17e-4096-84ae-7a188bebe8d0"},{"name":"Get Received Packages","id":"f32642b3-e2b7-4a4a-a2a0-c85e2f147df1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/received/","description":"

This endpoint returns a list of active packages that the user has received from other SendSafely users. The list will include expired (but not deleted) packages. Once a package is deleted by the owner it will not longer appear in the received package list for other users.

\n","urlObject":{"path":["package","received",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"77e3a7c8-225e-48f7-b2df-1acbb7e3ecc8","name":"Get Received Packages Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f32642b3-e2b7-4a4a-a2a0-c85e2f147df1"},{"name":"Get Archived Packages","id":"fd31618e-9e03-4f23-a00d-798067165b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/archived/","description":"

This endpoint returns a list of archived (deleted) packages that are owned by the user.

\n","urlObject":{"path":["package","archived",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"1e545031-14d9-47cd-ba74-54b0c5cdda26","name":"Get Archived Packages Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fd31618e-9e03-4f23-a00d-798067165b45"},{"name":"Get Sent Packages","id":"834e9dde-c8b1-4c39-bc2a-1d3ba8c584ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/","description":"

This endpoint returns all active and expired packages that were sent by the user.

\n","urlObject":{"path":["package",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"64af172c-736f-4713-9652-2de285e0a20b","name":"Get Sent Packages Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"834e9dde-c8b1-4c39-bc2a-1d3ba8c584ae"},{"name":"Search Package","id":"7a1d7173-7865-463c-904b-594adda0973c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"searchValue\": \"\",\n \"target\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/search/","urlObject":{"path":["package","search",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a1d7173-7865-463c-904b-594adda0973c"},{"name":"Get Workspace Packages","id":"a2cc7706-cb68-49de-9b28-3f19d4350f22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/workspaces/?rowIndex=0&pageSize=50&sortOrder=ASC&sortField=name","description":"

This endpoint returns a list of Workspace packages that the user is authorized to access.

\n","urlObject":{"path":["package","workspaces",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[{"key":"rowIndex","value":"0"},{"key":"pageSize","value":"50"},{"description":{"content":"

ASC, DESC

\n","type":"text/plain"},"key":"sortOrder","value":"ASC"},{"description":{"content":"

name, date, owner

\n","type":"text/plain"},"key":"sortField","value":"name"}],"variable":[]}},"response":[],"_postman_id":"a2cc7706-cb68-49de-9b28-3f19d4350f22"},{"name":"Bulk Add Recipient","id":"0a016630-9d68-4488-9fa8-3f089a0bea35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"email\": \"\", \"phoneNumber\": \"\", \"countryCode\":\"\", \"packageIds\": [\"\", \"\", \"\"]}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/bulk-add-recipient","urlObject":{"path":["package","bulk-add-recipient"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"f7e584c3-c0b6-4864-865c-d966fcefd99a","name":"Bulk Add Recipient Example","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"email\": \"\", \"phoneNumber\": \"\", \"countryCode\":\"\", \"packageIds\": [\"\", \"\", \"\"]}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/bulk-add-recipient"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"packageId\": \"\",\n \"response\": \"\",\n \"recipient\": {\n \"recipientId\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"needsApproval\": \"\",\n \"isPackageOwner\": \"\",\n \"checkForPublicKeys\": \"\",\n \"smsAuth\": \"\",\n \"isGuest\": \"\",\n \"response\": \"\"\n }\n },\n {\n \"packageId\": \"\",\n \"response\": \"\",\n \"message\": \"\"\n },\n {\n \"packageId\": \"\",\n \"response\": \"\",\n \"recipient\": {\n \"recipientId\": \"\",\n \"email\": \"\",\n \"needsApproval\": \"\",\n \"isPackageOwner\": \"\",\n \"checkForPublicKeys\": \"\",\n \"smsAuth\": \"\",\n \"isGuest\": \"\",\n \"response\": \"\"\n }\n }\n ],\n \"response\": \"\"\n}"}],"_postman_id":"0a016630-9d68-4488-9fa8-3f089a0bea35"},{"name":"Bulk Remove Recipient","id":"aec7116d-81b0-4396-afef-f4f2425f0473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\"email\": \"\", \"packageIds\": [\"\", \"\", \"\"]}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/bulk-remove-recipient","urlObject":{"path":["package","bulk-remove-recipient"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"6c09cbc6-15e3-4d42-bb33-e53973f14a68","name":"Bulk Remove Recipient","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\"email\": \"\", \"packageIds\": [\"\", \"\"]}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/bulk-remove-recipient"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"packageId\": \"\",\n \"response\": \"\"\n },\n {\n \"packageId\": \"\",\n \"response\": \"\",\n \"message\": \"\"\n }\n ],\n \"response\": \"\"\n}"}],"_postman_id":"aec7116d-81b0-4396-afef-f4f2425f0473"}],"id":"6e00a1d6-d52a-442e-9fc1-b59da7e89c9e","description":"

A package represents a set of files and/or an encrypted message sent via SendSafely. Endpoints within this path are used to perform operations on individual SendSafely packages that the authenticated API User has access to.

\n","_postman_id":"6e00a1d6-d52a-442e-9fc1-b59da7e89c9e"},{"name":"user","item":[{"name":"dropzone-recipients","item":[{"name":"Get Dropzone Recipients","id":"1b820d72-03d6-45de-8feb-2a56a175071d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/","description":"

This endpoint returns the list of recipients configured on the Dropzone owned by the user.

\n","urlObject":{"path":["user","dropzone-recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"87165192-d04a-44d9-978a-179dbd94093a","name":"Get Dropzone Recipients Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"recipientEmailAddresses\": [ \"\", \"\" ], \"response\": \"\"}"}],"_postman_id":"1b820d72-03d6-45de-8feb-2a56a175071d"},{"name":"Add Dropzone Recipients","id":"3c1cf7fb-0e2d-4ff3-b604-7b9a01e89f97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\", \"emails\": [ \"\", \"\"]}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/","description":"

This endpoint can be used to add one or more recipients to the Dropzone owned by the user.

\n","urlObject":{"path":["user","dropzone-recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"cc4dcc24-3171-4628-ad5f-874e66be5e3a","name":"Add Dropzone Recipients Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"emails\": [ \"\", \"\"], \"publicKey\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": { \"success\": \"\", \"successEmails\": [ \"\", \"\" ], \"warnEmails\": [ \"\", \"\" ], \"failEmails\": [ \"\", \"\" ] }}"}],"_postman_id":"3c1cf7fb-0e2d-4ff3-b604-7b9a01e89f97"},{"name":"Remove Dropzone Recipient","id":"d1564a1b-19ba-4017-b519-c8b3f184eb9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\", \"publicKey\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/","description":"

This endpoint can be used to remove a recipient from the Dropzone owned by the user.

\n","urlObject":{"path":["user","dropzone-recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"821172c4-c389-4154-9e46-67a64b5e3234","name":"Remove Dropzone Recipients Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"d1564a1b-19ba-4017-b519-c8b3f184eb9e"},{"name":"Get Dropzone Recipients By DropzoneId","id":"6c3036f4-bc09-4d2a-ba31-dfda8adca08d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/:publicKey","urlObject":{"path":["user","dropzone-recipients",":publicKey"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"ce900572-3ae0-4eb0-9183-2e7751213b93","type":"any","value":"dropzoneId","key":"publicKey"}]}},"response":[],"_postman_id":"6c3036f4-bc09-4d2a-ba31-dfda8adca08d"}],"id":"5270dff3-fbaf-484c-868c-5fd3c229ee32","description":"

Every Dropzone has one or more recipients. Dropzone recipients are automatically able to access all packages that get uploaded to the Dropzone.

\n","_postman_id":"5270dff3-fbaf-484c-868c-5fd3c229ee32"},{"name":"{user Id}","item":[{"name":"Update Dropzone Configuration","id":"20dfc1a5-5361-4367-bfda-64e122e2cf2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"dropzonePostUrl\": \"\",\"dropzoneTextLabel\": \"\",\"dropzoneNotificationType\": \"\",\"dropzoneEnableMessage\": \"\",\"dropzoneRequireAuthentication\": \"\",\"dropzoneEnable\": \"\", \"dropzoneWhiteList\": \"\", \"dropzoneLife\": \"\", \"dropzoneRestrictDownload\": \"\", \"publicKey\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/:userId/dropzone/config/","description":"

This endpoint can be used to update the configuration settings for the Dropzone owned by the user.

\n","urlObject":{"path":["user",":userId","dropzone","config",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"8cbc3f23-b1a5-4ccb-8736-53b7cb6b76a3","type":"any","value":"","key":"userId"}]}},"response":[{"id":"33d19114-c4f4-4143-abf4-9a557d84fffa","name":"Update Dropzone Configuration Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"dropzoneTextLabel\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user//dropzone/config/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"dropzoneRecipients\": [ \"\", \"\" ], \"dropzoneLife\": \"\", \"dropzoneExternalPostUrl\": \"\", \"dropzoneTextLabel\": \"\", \"dropzoneEnableSecureMessage\": \"\", \"dropzoneRequireAuthentication\": \"\", \"dropzoneNotificationType\": \"\", \"dropzoneUrl\": \"\", \"publicKey\": \"\", \"publicSecret\": \"\", \"isDropzoneEnabled\": \"\", \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"20dfc1a5-5361-4367-bfda-64e122e2cf2c"}],"id":"3ab34301-52dc-4ea6-9cb2-1cf26db0c0bc","description":"

The unique identifier for one user registered within your SendSafely portal.

\n","_postman_id":"3ab34301-52dc-4ea6-9cb2-1cf26db0c0bc"},{"name":"Get User Information","id":"be169b63-ad14-4a6b-b2ac-a908391c115c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/","description":"

This endpoint returns the profile information for the current API user.

\n","urlObject":{"path":["user",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"3c55c806-5810-415e-bca1-3100fb6c320b","name":"Get User Information Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"\", \"email\": \"\", \"clientKey\": \"\", \"firstName\": \"\", \"lastName\": \"\", \"betaUser\": \"\", \"adminUser\": \"\", \"publicKey\": \"\", \"packageLife\": \"\", \"response\": \"\"}"}],"_postman_id":"be169b63-ad14-4a6b-b2ac-a908391c115c"},{"name":"Get User Contact Groups","id":"796b16e9-5205-40e8-b7be-1a746f3145f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/groups/","description":"

This endpoint returns a list of the user's personal contact groups along with the members.

\n","urlObject":{"path":["user","groups",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"438ab50c-2a1e-4a0c-b5b5-cca6c1a8a8fd","name":"Get User Contact Groups","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"\", \"email\": \"\", \"clientKey\": \"\", \"firstName\": \"\", \"lastName\": \"\", \"betaUser\": \"\", \"adminUser\": \"\", \"publicKey\": \"\", \"packageLife\": \"\", \"response\": \"\"}"}],"_postman_id":"796b16e9-5205-40e8-b7be-1a746f3145f7"}],"id":"bf3f2cfa-7c89-4e6e-b596-0da88513455d","description":"

A user represents a licensed user account within your organization's SendSafely web portal. Endpoints within this path are used to perform operations related to user-level profile settings for the authenticated API user.

\n","_postman_id":"bf3f2cfa-7c89-4e6e-b596-0da88513455d"},{"name":"group","item":[{"name":"{group Id}","item":[{"name":"Get Contact Group","id":"11f46563-53ce-4ced-b8bd-aff2b97eb40e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group/:groupId/","description":"

This endpoint returns one of the user's personal contact groups or an enterprise contact group.

\n","urlObject":{"path":["group",":groupId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[{"disabled":true,"key":"rowIndex","value":"0"},{"disabled":true,"key":"pageSize","value":"100"}],"variable":[{"id":"95450334-52e7-4e8a-9bd6-f088a6a27695","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"d27f6491-0742-4a4f-90e6-43fa1e9479f4","name":"Get Contact Group Response","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/group//","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["group","",""],"query":[{"key":"rowIndex","value":"0","disabled":true},{"key":"pageSize","value":"100","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contactGroup\": {\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupIsOrganizationGroup\": \"\",\n \"users\": [\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n },\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n }\n ]\n },\n \"pagination\": {\n \"rowIndex\": \"\",\n \"rowsReturned\": \"\"\n },\n \"response\": \"\"\n}"}],"_postman_id":"11f46563-53ce-4ced-b8bd-aff2b97eb40e"},{"name":"Delete Contact Group","id":"b4eb070d-b0d6-46fc-840a-db4a75f4e2c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group/:groupId/","description":"

This endpoint can be used to delete one of the user's personal contact groups or an enterprise contact group.

\n","urlObject":{"path":["group",":groupId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"e72b7f88-53f8-4662-961d-b546680c4302","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"ffac6b06-1aca-48ca-812c-f23214237b09","name":"Delete Contact Group Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"b4eb070d-b0d6-46fc-840a-db4a75f4e2c0"},{"name":"Add Contact Group Member","id":"1d846397-9f60-4a1e-a327-2fe390f8f3bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group/:groupId/user/","description":"

This endpoint can be used to add someone to one of the user's personal contact groups or an enterprise contact group.

\n","urlObject":{"path":["group",":groupId","user",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"d9a205cf-bc42-4913-af09-d533eb223502","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"b52b0f2c-9b97-4228-9c8e-3f247ffd2e9e","name":"Add Contact Group Member Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group//user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"userId\": \"\", \"userEmail\": \"\", \"response\": \"\"}"}],"_postman_id":"1d846397-9f60-4a1e-a327-2fe390f8f3bd"},{"name":"Remove Contact Group Member","id":"88857c02-d0c6-4e28-9489-4887edef1f1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group/:groupId/:userId/","description":"

This endpoint can be used to remove someone from one of the user's personal contact groups or an enterprise contact group.

\n","urlObject":{"path":["group",":groupId",":userId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"42f77e8b-a5ce-4571-98fb-dfa1d6def052","type":"any","value":"","key":"groupId"},{"id":"99316fd3-5b14-4e8b-ac94-846647a86bba","type":"any","value":"","key":"userId"}]}},"response":[{"id":"256a8e6b-9219-4065-9b01-60c880bfd5a5","name":"Remove Contact Group Member Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group///"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"88857c02-d0c6-4e28-9489-4887edef1f1a"}],"id":"0f5f2331-1e5e-4a41-bb0f-33fd0a1277e3","description":"

The unique identifier for a specific contact group.

\n","_postman_id":"0f5f2331-1e5e-4a41-bb0f-33fd0a1277e3"},{"name":"Create Contact Group","id":"55cdbc5c-ccb2-46a7-b885-819446569031","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"groupName\": \"\",\"isEnterpriseGroup\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group/","description":"

This endpoint can be used to create a new personal or enterprise contact group.

\n","urlObject":{"path":["group",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"6ef5b4cc-8601-46f5-904f-37a056fd2a53","name":"Create Contact Group Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"groupName\": \"\",\"isEnterpriseGroup\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"contactGroupId\": \"\", \"contactGroupName\": \"\", \"contactGroupUserEmails\": [ \"\", \"\" ], \"response\": \"\"}"}],"_postman_id":"55cdbc5c-ccb2-46a7-b885-819446569031"}],"id":"fed24334-368a-476b-b54e-4be7397fab3a","description":"

A SendSafely Contact group is a list of email addresses that can be re-used to add multiple recipients to a package. Contact groups can be defined at the user level (User Contact Groups) or at the organization level (Enterprise Contact Groups). Endpoints within this path are used to perform operations on groups that the authenticated API user has access to.

\n","_postman_id":"fed24334-368a-476b-b54e-4be7397fab3a"},{"name":"public-key","item":[{"name":"{public Key Id}","item":[{"name":"Delete Public Key","id":"886d9a20-81af-4c9d-a1fd-67febab0b70e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key/:publicKeyId/","description":"

This endpoint allows a user to delete one of their trusted device keys.

\n","urlObject":{"path":["public-key",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"2bcfae8e-5e03-4c1f-ad6e-a25bd7529397","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"15445442-e247-460f-86c8-73eba34454da","name":"Delete Public Key Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"886d9a20-81af-4c9d-a1fd-67febab0b70e"},{"name":"Get Public Key by ID","id":"8e950b5d-076d-4fad-b2ff-e6e00261ca94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key/:publicKeyId/","description":"

Gets the public key using its ID.

\n","urlObject":{"path":["public-key",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"77731596-94bb-48b4-8874-dbe01eb27463","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"67a71bf6-6399-4e39-94c1-fd621eb93c45","name":"Get Public Key by ID Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/sync//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"publicKey\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"8e950b5d-076d-4fad-b2ff-e6e00261ca94"}],"id":"9f564264-268a-4035-9807-949044757c1b","description":"

The unique identifier for a specific trusted browser public key.

\n","_postman_id":"9f564264-268a-4035-9807-949044757c1b"},{"name":"Add Public Key","id":"e5e13a5d-e31f-4eb7-9d17-3d5fa5a1c1ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"publicKey\": \"\",\"description\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key/","description":"

This endpoint allows a user to add a new trusted device key.

\n","urlObject":{"path":["public-key",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"de21d4cb-a544-4185-8796-1e88ccb82101","name":"Add Public Key Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"publicKey\": \"\",\"description\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"\", \"description\": \"\", \"dateStr\": \"\", \"response\": \"\"}"}],"_postman_id":"e5e13a5d-e31f-4eb7-9d17-3d5fa5a1c1ec"}],"id":"0fd85316-8169-48ec-9e26-74edeffdf410","description":"

The public key portion of an individual Trusted Device key. Endpoints within this path are used to perform operations on device keys that belong to the authenticated API user.

\n","_postman_id":"0fd85316-8169-48ec-9e26-74edeffdf410"},{"name":"enterprise","item":[{"name":"security-groups","item":[{"name":"Get Security Groups","id":"eb655889-e0b4-4e0a-95d1-ec5a365af12f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise","security-groups"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"eee4397f-0ec1-4a55-b040-1998114c706c","name":"Get Security Groups Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"securityGroups\": [\n {\n \"securityGroupId\": \"\",\n \"securityGroupName\": \"\",\n \"securityGroupPermissions\": [\n {\n \"securityGroupPermission\": \"\"\n },\n {\n \"securityGroupPermission\": \"\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"rowIndex\": \"\",\n \"rowsReturned\": \"\"\n },\n \"response\": \"\"\n}"}],"_postman_id":"eb655889-e0b4-4e0a-95d1-ec5a365af12f"},{"name":"Get Security Groups By Id","id":"723bd561-a584-4c8a-9aff-17a7022ebc1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise","security-groups","{securityGroupId}"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"652099fe-0cb9-4d18-8ed6-097cc6d2c203","name":"Get Security Groups By Id Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"securityGroupMembers\": [],\n \"totalMembersCount\": \"\",\n \"rangeStart\": \"\",\n \"rangeEnd\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"723bd561-a584-4c8a-9aff-17a7022ebc1b"},{"name":"Add Security Groups Member","id":"ecfadd5f-07d6-4c75-bedb-eebb39fe6795","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise","security-groups","{securityGroupId}"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"a1fccd36-cd1e-4f32-a12a-672ab5b82ea3","name":"Add Security Groups Member Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"ecfadd5f-07d6-4c75-bedb-eebb39fe6795"},{"name":"Delete Security Groups Member","id":"cf5b48d6-05ba-4030-8df4-22490db81058","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise","security-groups","{securityGroupId}"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"681c59a4-8e70-4ed1-8e08-be736d3d3661","name":"Delete Security Groups Member Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"cf5b48d6-05ba-4030-8df4-22490db81058"}],"id":"808540b5-f9ee-4463-9d44-9f780083c5da","_postman_id":"808540b5-f9ee-4463-9d44-9f780083c5da","description":""},{"name":"Get Enterprise Information","id":"660a39c9-7f67-455b-b2de-5e2e1fdbf8b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"744618ee-da7a-42d7-9767-e8b89dfc3fa5","name":"Get Enterprise Information Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"host\": \"\",\n \"systemName\": \"\",\n \"allowUndisclosedRecipients\": \"\",\n \"outlookBeta\": \"\",\n \"messageEncryption\": \"\",\n \"linkColor\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"660a39c9-7f67-455b-b2de-5e2e1fdbf8b7"},{"name":"Get Enterprise Contact Groups","id":"06198d0e-6050-4cc8-9502-4cb54158935c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/groups/","description":"

Get enterprise contact groups

\n","urlObject":{"path":["enterprise","groups",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"80cfdb20-63a5-4a53-9acc-6dd958038a7f","name":"Get Enterprise Contact Groups Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/groups/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contactGroups\": [\n {\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupIsOrganizationGroup\": \"\",\n \"users\": [\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n },\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n }\n ]\n },\n {\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupIsOrganizationGroup\": \"\",\n \"users\": [\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n },\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n }\n ]\n }\n ],\n \"response\": \"\"\n}"}],"_postman_id":"06198d0e-6050-4cc8-9502-4cb54158935c"},{"name":"Get AuditLog","id":"83f8a198-3adb-4a28-9577-251cc2486a1f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"eventType\": \"\", //Filter results to only include a specific event type. Can be PACKAGE_FILE_DOWNLOAD, FINALIZE_PACKAGE, WORKSPACE_UPLOAD, WORKSPACE_DOWNLOAD, ADMIN_EVENT, USER_EVENT. Leave blank to return all event types. \n \"ipAddress\": \"\", //Filter results to only include entries originating from a specific IP address\n \"authenticatedUser\": \"\", //Filter results to only include entries originating from a specific user (email address)\n \"impersonatedUser\": \"\", //Filter results to only include entries where this user is being impersonated by an admin (email address)\n \"packageOwner\": \"\", //Filter results to only include packages owned by this user (email address)\n \"minTimestamp\": \"\", //Filter results to only include entries after this date/time. Format can be yyyy-MM-dd HH:mm:ss or yyyy-MM-dd) \n \"maxTimestamp\": \"\", //Filter results to only include entries before this date/time. Format can be yyyy-MM-dd HH:mm:ss or yyyy-MM-dd) \n \"pageSize\": 100, //How many records you want returned in each page. Can be any number from 1 to 100. \n \"rowIndex\": 0 //Offset of the first record to be returned in this page. Leave blank for the first page, otherwise use the nextRowIndex value returned from the previous page. \n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/audit-logs/","description":"

This endpoint returns Audit Log entries related to activity within your SendSafely portal. The calling user must be a SendSafely Enterprise Administrator, and the organizaiton must have Audit Logging enabled.

\n","urlObject":{"path":["enterprise","audit-logs",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"6d39459f-748b-4880-b6ac-8ec63ba9046d","name":"Get AuditLog Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/groups/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"auditLog\": [\n {\n \"eventType\": \"PACKAGE_FILE_DOWNLOAD\",\n \"ipAddress\": \"127.0.0.1\",\n \"authenticatedUser\": \"user@example.com\",\n \"impersonatedUser\": null,\n \"packageOwner\": \"employee@yourcompany.com\",\n \"logDetails\": {\n \"packageId\": \"1234-ABCD\",\n \"fileName\": \"My Report.pdf\",\n \"fileSize\": \"2434812\",\n \"packageType\": \"DROPZONE\"\n },\n \"timestamp\": \"2023-01-01 12:00:00 UTC\"\n },\n {\n \"eventType\": \"PACKAGE_FILE_DOWNLOAD\",\n \"ipAddress\": \"127.0.0.1\",\n \"authenticatedUser\": \"user@example.com\",\n \"impersonatedUser\": null,\n \"packageOwner\": \"employee@yourcompany.com\",\n \"logDetails\": {\n \"packageId\": \"AAAA-9999\",\n \"fileName\": \"Another File.pdf\",\n \"fileSize\": \"1728364\",\n \"packageType\": \"DROPZONE\"\n },\n \"timestamp\": \"2023-01-01 12:00:00 UTC\"\n }\n ],\n \"pagination\": {\n \"rowIndex\": \"0\",\n \"rowsReturned\": \"0\"\n },\n \"response\": \"SUCCESS\",\n \"message\": \"AuditLog query successful\"\n}"}],"_postman_id":"83f8a198-3adb-4a28-9577-251cc2486a1f"}],"id":"3e27578f-4567-49fa-a1c8-a37f44f2a521","description":"

The enterprise organization that manages a specific SendSafely portal and all registered users within it. Endpoints within this path are used to perform operations on enterprise-level data for the organization that the authenticated API user belongs to.

\n","_postman_id":"3e27578f-4567-49fa-a1c8-a37f44f2a521"},{"name":"organization","item":[{"name":"Update IP Allow List","id":"0fec76d9-3fdb-40bd-be00-480faeb0ccc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enableAllowList\": \"\",\n \"allowedIpRanges\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/organization/ip-whitelist","description":"

Update the IP allow list configuration for your organization. The calling user must be a SendSafely Enterprise Administrator. When enableAllowList is true, only requests originating from the IP addresses or CIDR ranges in allowedIpRanges will be permitted to access the SendSafely portal. IP ranges must be provided in CIDR notation.

\n","urlObject":{"path":["organization","ip-whitelist"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"f6a63c86-c46a-40b8-bbc2-06d1c31d26c6","name":"Update IP Allow List Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enableAllowList\": \"\",\n \"allowedIpRanges\": [\n \"\",\n \"\"\n ]\n}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/organization/ip-whitelist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"0fec76d9-3fdb-40bd-be00-480faeb0ccc9"},{"name":"Get IP Allow List","id":"e09f1f0c-24b6-43d8-b05d-1aaf05a84484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/organization/ip-whitelist","description":"

Get the IP allow list configuration for your organization. The calling user must be a SendSafely Enterprise Administrator. Returns the list of IP addresses or CIDR ranges currently configured.

\n","urlObject":{"path":["organization","ip-whitelist"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"8f141d29-6508-46c0-bee9-209a510943cd","name":"Get IP Allow List Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/organization/ip-whitelist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ipAddresses\": [\n \"\",\n \"\"\n ],\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"e09f1f0c-24b6-43d8-b05d-1aaf05a84484"}],"id":"ab0b3152-8a57-4afb-abe0-5b58b4cf9a32","description":"

Endpoints within this path are used to perform operations on organization-level configuration for the organization that the authenticated API user belongs to.

\n","_postman_id":"ab0b3152-8a57-4afb-abe0-5b58b4cf9a32"},{"name":"sync","item":[{"name":"Sync Public Key","id":"19cd6b1d-b191-4d4f-8454-922953129005","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/sync/:publicKeyId/","description":"

This endpoint returns a list of keycodes that are eligible to be sync'd using a specific trusted device key.

\n","urlObject":{"path":["sync",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"4afd1288-8467-419e-9abf-dec688a81c95","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"b483cea6-b4a3-4516-b094-089a1036a6ec","name":"Sync Public Key Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/sync//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"keycodes\": [ \"\", \"\" ], \"publicKeys\": [ { \"id\": \"\", \"key\": \"\" }, { \"id\": \"\", \"key\": \"\" } ], \"response\": \"\"}"}],"_postman_id":"19cd6b1d-b191-4d4f-8454-922953129005"}],"id":"60bc0e8c-6d8e-466c-8dd1-d05cd910e57c","description":"

Endpoints within this path are used to synchronize keycodes using a particular trusted device key.

\n","_postman_id":"60bc0e8c-6d8e-466c-8dd1-d05cd910e57c"},{"name":"recipient","item":[{"name":"Get Recipient Packages History","id":"ace7ce46-c7d0-4454-862d-f69f51a2736c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/recipient/history/:recipientEmail/","description":"

This endpoint gets historical information about the packages sent to a particular recipient email address.

\n","urlObject":{"path":["recipient","history",":recipientEmail",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"2aeadb30-bb35-4c9a-83fb-5917496987e2","type":"any","value":"","key":"recipientEmail"}]}},"response":[{"id":"8f0011f9-5dec-472a-bb2a-751deb9875f6","name":"Get Recipient Packages History Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"role\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packages\": [\n {\n \"packageId\": \"\",\n \"packageUserName\": \"\",\n \"packageUserId\": \"\",\n \"packageState\": \"\",\n \"packageLife\": \"\",\n \"packageBrowser\": \"\",\n \"packageOS\": \"\",\n \"recipient\": {\n \"recipientId\": \"\",\n \"email\": \"\",\n \"needsApproval\": \"\",\n \"confirmations\": [],\n \"isPackageOwner\": \"\",\n \"checkForPublicKeys\": \"\",\n \"smsAuth\": \"\",\n \"isGuest\": \"\"\n },\n \"filenames\": [],\n \"packageContainsMessage\": \"\"\n },\n {\n \"packageId\": \"\",\n \"packageUserName\": \"\",\n \"packageUserId\": \"\",\n \"packageState\": \"\",\n \"packageLife\": \"\",\n \"packageBrowser\": \"\",\n \"packageOS\": \"\",\n \"recipient\": {\n \"recipientId\": \"\",\n \"email\": \"\",\n \"needsApproval\": \"\",\n \"confirmations\": [],\n \"isPackageOwner\": \"\",\n \"checkForPublicKeys\": \"\",\n \"smsAuth\": \"\",\n \"isGuest\": \"\"\n },\n \"filenames\": [],\n \"packageContainsMessage\": \"\"\n }\n ],\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"ace7ce46-c7d0-4454-862d-f69f51a2736c"}],"id":"5bda27ab-4c37-431e-ba75-5b23526e898c","description":"

Package recipient information

\n","_postman_id":"5bda27ab-4c37-431e-ba75-5b23526e898c"},{"name":"config","item":[{"name":"Verify Credentials","id":"863b2424-122a-4226-8fe0-3376ee3f77cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/config/verify-credentials/","description":"

This endpoint verifies the API user's credentials.

\n","urlObject":{"path":["config","verify-credentials",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"303aaf93-4c54-4c49-8429-16edce6c5a11","name":"Verify Credentials Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/sync//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requiresApprover\": \"\",\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"863b2424-122a-4226-8fe0-3376ee3f77cb"}],"id":"a4209e66-874f-4c65-baf2-0400f711b67e","description":"

API Configuration

\n","_postman_id":"a4209e66-874f-4c65-baf2-0400f711b67e"},{"name":"Workflows","item":[{"name":"Workflows Callback","id":"34a7129c-a4b6-42d5-9363-f7fb8df293f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \"runnerId\": \"\",\"actionId\": \"\",\"callbackToken\": \"\",\"result\": \"\",\"message\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/callback","urlObject":{"path":["workflow","callback"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"332d2eb4-f5cf-4ecd-8402-925170df3724","name":"Workflows Callback Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"runnerId\": \"\",\n \"actionId\": \"\",\n \"callbackToken\": \"\",\n \"result\": \"\",\n \"message\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/callback"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"Workflow resumed for runner id \"\n}"}],"_postman_id":"34a7129c-a4b6-42d5-9363-f7fb8df293f9"},{"name":"Add Workflow","id":"8dff313e-1c71-4675-9cf6-eab5c1746e5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"workflowEventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/","urlObject":{"path":["workflow",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"fa7f89ba-ecac-4833-bc79-13d2487de379","name":"Add Workflow Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"eventFilters\": []\n}"}],"_postman_id":"8dff313e-1c71-4675-9cf6-eab5c1746e5c"},{"name":"Add Enterprise Workflow","id":"931874cf-ff50-479e-ba2e-fcbeb3753134","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"workflowEventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/workflow/","urlObject":{"path":["enterprise","workflow",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"04729f88-be81-40b0-b9de-91b34aa49a48","name":"Add Enterprise Workflow Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/workflow/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"eventFilters\": []\n}"}],"_postman_id":"931874cf-ff50-479e-ba2e-fcbeb3753134"},{"name":"Get Workflow","id":"72b02767-6909-446a-8f2d-a2f1e4b03cb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","urlObject":{"path":["workflow",":workflowId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[{"disabled":true,"key":"workflowId","value":null}],"variable":[{"id":"b678f899-7cbb-4698-a999-1b6945d93aa4","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"2a0c45af-614c-49d3-af71-d873ccdc42c6","name":"Get Workflow Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId"],"query":[{"key":"workflowId","value":null,"disabled":true}],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"eventFilters\": [],\n \"actions\": []\n}"}],"_postman_id":"72b02767-6909-446a-8f2d-a2f1e4b03cb5"},{"name":"Get Workflows","id":"9459b1e4-bd1b-4ed3-a57c-75e266d3e502","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflows/","urlObject":{"path":["workflows",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"2ba93083-3276-4501-8d89-0992056b50ac","name":"Get Workflows Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflows/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowIsOrgScope\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"modifiedTimestamp\": \"\",\n \"actions\": [\n {\n \"actionId\": \"\",\n \"actionOrder\": \"\",\n \"actionType\": \"\",\n \"actionNotify\": \"\"\n }\n ],\n \"eventFilters\": [\n {\n \"filterId\": \"\",\n \"filterType\": \"\",\n \"filterValue\": \"\",\n \"filterOperator\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"9459b1e4-bd1b-4ed3-a57c-75e266d3e502"},{"name":"Get Enterprise Workflows","id":"e55acedb-f8e0-4078-b5ae-861c5a18e9d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/workflows/","urlObject":{"path":["enterprise","workflows",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"36ed297d-66a9-4239-8f7d-640d82ab2565","name":"Get Enterprise Workflows Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/workflows/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowIsOrgScope\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"modifiedTimestamp\": \"\",\n \"actions\": [\n {\n \"actionId\": \"\",\n \"actionOrder\": \"\",\n \"actionType\": \"\",\n \"actionNotify\": \"\"\n }\n ],\n \"eventFilters\": [\n {\n \"filterId\": \"\",\n \"filterType\": \"\",\n \"filterValue\": \"\",\n \"filterOperator\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"e55acedb-f8e0-4078-b5ae-861c5a18e9d9"},{"name":"Update Workflow","id":"887f91dc-9668-4a1a-a6fd-37c8d1ee489a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"workflowPriority\": \"\", \"workflowStatus\": \"\", \"workflowName\": \"\", \"workflowIdentity\": \"\", \"workflowNotificationEmail\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","urlObject":{"path":["workflow",":workflowId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"31f75094-73d0-4a07-bef9-412a2b417e24","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"e5764a03-384c-460f-9d84-89a3ce73e5b0","name":"Update Workflow Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"priority\": \"\", \"status\": \"\", \"name\": \"\", \"identity\": \"\", \"notificationEmail\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId"],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"eventFilters\": [],\n \"actions\": []\n}"}],"_postman_id":"887f91dc-9668-4a1a-a6fd-37c8d1ee489a"},{"name":"Delete Workflow","id":"180fb1b9-35eb-4009-9ba5-819339f0bb10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","urlObject":{"path":["workflow",":workflowId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"69e2d64f-3cad-44b7-a68f-d2516636b524","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"6f319b52-2ba0-4612-b1b0-d34e2558de4c","name":"Delete Workflow Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId"],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"180fb1b9-35eb-4009-9ba5-819339f0bb10"},{"name":"Add Workflow Filter","id":"8df1a342-dc04-41cf-aba0-4b4b6512b7a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"filterType\": \"\",\"filterValue\": \"\",\"filterOperator\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/filter","urlObject":{"path":["workflow",":workflowId","filter"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"f039f893-031c-4dce-ad4f-6f1eed5ba417","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"8e6905da-b09f-4a34-9382-17ed4d6e4071","name":"Add Workflow Filter Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"filterType\": \"\",\"filterValue\": \"\",\"filterOperator\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/filter","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","filter"],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"filterId\": \"\",\n \"filterType\": \"\",\n \"filterValue\": \"\",\n \"filterOperator\": \"\"\n}"}],"_postman_id":"8df1a342-dc04-41cf-aba0-4b4b6512b7a8"},{"name":"Delete Workflow Filter","id":"0388d2fb-a0f6-4af9-8905-0fd44f5aabad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/filter/:filterId","urlObject":{"path":["workflow",":workflowId","filter",":filterId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"55076c58-994c-4c6b-ab5f-a5500a20a2c6","type":"any","value":"","key":"workflowId"},{"id":"a94b72d9-be8c-44d2-900e-da2242ee6153","type":"any","value":"","key":"filterId"}]}},"response":[{"id":"01a6f3e0-4197-473a-8b0f-08089dfb8b89","name":"Delete Workflow Filter Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/filter/:filterId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","filter",":filterId"],"variable":[{"key":"workflowId","value":""},{"key":"filterId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"0388d2fb-a0f6-4af9-8905-0fd44f5aabad"},{"name":"Add Action","id":"c36fc395-5ea3-4eea-b08a-1545e66f6a64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"actionType\": \"\", \"actionInput\": \"\", \"actionNotify\": \"\", \"actionOrder\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/","urlObject":{"path":["workflow",":workflowId","action",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"5ce88614-a0ca-4e4d-abf6-69db52c05de8","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"e5ccc35c-216a-46d7-bc8c-c5011e8fe22b","name":"Add Action Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"actionType\": \"\", \"actionInput\": \"\", \"actionNotify\": \"\", \"actionOrder\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",""],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"actionId\": \"\",\n \"actionOrder\": \"\",\n \"actionType\": \"\",\n \"actionNotify\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"c36fc395-5ea3-4eea-b08a-1545e66f6a64"},{"name":"Update Action","id":"a17b699c-dd15-4e38-a00e-deffca32f270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"actionInput\":\"\", \"actionNotify\":\"\", \"actionOrder\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId","urlObject":{"path":["workflow",":workflowId","action",":actionId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"5651f57e-57e1-4f7a-9981-8170de6b55f7","type":"any","value":"","key":"workflowId"},{"id":"1ec66ec0-80e1-40ad-8aa9-842c74b8018d","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"f0d017ff-f396-4784-8dec-f01e0c3c7452","name":"Update Action Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"actionInput\":\"\", \"actionNotify\":\"\", \"actionOrder\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"actionId\": \"\",\n \"actionOrder\": \"\",\n \"actionType\": \"\",\n \"actionNotify\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"a17b699c-dd15-4e38-a00e-deffca32f270"},{"name":"Delete Action","id":"690755f2-34ac-4903-b213-676bbb43bb71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId","urlObject":{"path":["workflow",":workflowId","action",":actionId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"ab879590-0688-4b23-9442-e3b885280a4b","type":"any","value":"","key":"workflowId"},{"id":"315817fc-0945-4e6b-91cf-d54b8b6959fe","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"c21a956f-e3b6-4187-8733-ba96970aca93","name":"Delete Action Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"690755f2-34ac-4903-b213-676bbb43bb71"},{"name":"Add Action Filter","id":"6861ef91-20e9-43f5-afa1-5c0240c83367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"filterType\": \"\", \"filterValue\": \"\", \"filterOperator\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/filter","urlObject":{"path":["workflow",":workflowId","action",":actionId","filter"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"469e3c8b-1493-464d-ba2d-a3c4faeba5b2","type":"any","value":"","key":"workflowId"},{"id":"3acbe6e8-18a1-4db3-a4fe-b068086523db","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"6c2a143c-b926-4eea-950f-fdde90fe4fcb","name":"Add Action Filter Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"filterType\": \"\", \"filterValue\": \"\", \"filterOperator\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/filter","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId","filter"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"filterId\": \"\",\n \"filterType\": \"\",\n \"filterValue\": \"\",\n \"filterOperator\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"6861ef91-20e9-43f5-afa1-5c0240c83367"},{"name":"Delete Action Filter","id":"fc234c38-bc7d-4482-ad7e-3715ba4aaf2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/filter/:filterId","urlObject":{"path":["workflow",":workflowId","action",":actionId","filter",":filterId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"5b13128f-0abb-4f1c-ba21-44c5451de95b","type":"any","value":"","key":"workflowId"},{"id":"533573a3-869d-49c4-b6b8-3ff96af9f504","type":"any","value":"","key":"actionId"},{"id":"5bc6a4a5-2824-4ee7-a271-c43aa25f0185","type":"any","value":"","key":"filterId"}]}},"response":[{"id":"2dd939c6-bd20-445e-8a95-a8d76dadc6be","name":"Delete Action Filter Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/filter/:filterId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId","filter",":filterId"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""},{"key":"filterId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"fc234c38-bc7d-4482-ad7e-3715ba4aaf2f"},{"name":"Get Workflow Metadata","id":"aa6e1093-bac4-4486-aa61-851038e23728","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/metadata/","urlObject":{"path":["workflow","metadata",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"b0e75e97-ce52-4bf2-ba4e-91d759149955","name":"Get Workflow Metadata Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/metadata/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"eventType\": \"\",\n \"supportedEventProperties\": [\"\"],\n \"supportedEventFilters\": [\"\"]\n}"}],"_postman_id":"aa6e1093-bac4-4486-aa61-851038e23728"},{"name":"Execution Logs","id":"4c1cec23-ec27-417e-a067-f8f0c3d8337c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflows/execution-logs?workflowId=&type=&state=&workflowIdentity=&fromDateTime=&toDateTime=","urlObject":{"path":["workflows","execution-logs"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[{"disabled":true,"key":"executionId","value":""},{"key":"workflowId","value":""},{"key":"type","value":""},{"key":"state","value":""},{"key":"workflowIdentity","value":""},{"key":"fromDateTime","value":""},{"key":"toDateTime","value":""}],"variable":[]}},"response":[{"id":"a21417ba-a886-402a-a46e-2b8c81d7059b","name":"Execution Logs Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/execution-logs?executionId=&workflowId=&type=&state=&workflowIdentity=&fromDateTime=&toDateTime=","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","execution-logs"],"query":[{"key":"executionId","value":""},{"key":"workflowId","value":""},{"key":"type","value":""},{"key":"state","value":""},{"key":"workflowIdentity","value":""},{"key":"fromDateTime","value":""},{"key":"toDateTime","value":""}],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"executionLogs\": [\n {\n \"workflowId\": \"\",\n \"eventPayloadId\": \"\",\n \"workflowName\": \"\",\n \"runnerId\": \"\",\n \"createTimestamp\": \"\",\n \"startTimestamp\": \"\",\n \"endTimestamp\": \"\",\n \"state\": \"\",\n \"eventTarget\": \"\",\n \"workflowIdentity\": \"\",\n \"orgScope\": \"\",\n \"organizationId\": \"\",\n \"eventPayload\": {\n \"eventType\": \"\",\n \"eventProperties\": {\n \"authenticatedUser\": \"\",\n \"organizationId\": \"\",\n \"packageId\": \"\",\n \"packageOwner\": \"\",\n \"packageType\": \"\",\n \"uploader\": \"\",\n \"recipientEmails\": [\"\"],\n \"ipAddress\": \"\",\n \"dateTime\": \"\",\n \"keylessPackageLink\": \"\",\n \"isGuest\": \"\"\n }\n },\n \"executionResults\": [\n {\n \"step\": \"\",\n \"actionId\": \"\",\n \"actionType\": \"\",\n \"input\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"result\": \"\",\n \"message\": \"\",\n \"notify\": \"\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"4c1cec23-ec27-417e-a067-f8f0c3d8337c"},{"name":"Get Action Secret","id":"156e099c-9648-4896-95a7-3a3725138866","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/secret","urlObject":{"path":["workflow",":workflowId","action",":actionId","secret"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"62d31c60-aa7f-4195-ba74-77b196fd6598","type":"any","value":"","key":"workflowId"},{"id":"0f98703c-56e3-41ba-80fd-1e1633bffb84","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"057dc076-c5d8-449b-99ea-a9b5e35efb65","name":"Get Action Secret Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/secret","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId","secret"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"actionSecret\": \"\"}s"}],"_postman_id":"156e099c-9648-4896-95a7-3a3725138866"},{"name":"Replay Workflow","id":"89eaa98b-aa9f-4dde-bff4-f61c45f4fea0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": {\n \"eventPayloadId\": [\"\", \"\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflows/replay/","urlObject":{"path":["workflows","replay",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"695f124c-d9d0-47d7-8253-16d9b5371c5a","name":"Replay Workflows Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"executionLogs\": {\n \"workflowId\":\"\",\n \"workflowName\":\"\",\n \"runnerId\":\"\",\n \"eventPayloadId\":\"\",\n \"eventTimestamp\":\"\",\n \"createTimestamp\":\"\",\n \"startTimestamp\":\"\",\n \"endTimestamp\":\"\",\n \"eventTarget\":\"\",\n \"workflowIdentity\":\"\",\n \"orgScope\":\"\",\n \"organizationId\":\"\",\n \"eventPayload\":{\n \"eventType\":\"\",\n \"eventProperties\":{\n \"authenticatedUser\":\"\",\n \"organizationId\":\"\",\n \"packageId\":\"\",\n \"packageOwner\":\"\",\n \"packageType\":\"\",\n \"uploader\":\"\",\n \"recipientEmails\":[\"\",\"\"],\n \"ipAddress\":\"\",\n \"dateTime\":\"\",\n \"keylessPackageLink\":\"\",\n \"isGuest\":\"\"\n }\n },\n \"executionResults\":[\n {\n \"step\":\"\",\n \"actionId\":\"\",\n \"actionType\":\"\",\n \"start\":\"\",\n \"end\":\"\",\n \"result\":\"\",\n \"message\":\"\",\n \"notify\":\"\"\n }\n ],\n \"state\":\"\"\n }, \n \"response\": \"\"\n}"}],"_postman_id":"89eaa98b-aa9f-4dde-bff4-f61c45f4fea0"}],"id":"51bf77fa-e992-43f5-8bb5-129b8c142e06","description":"

Workflows API

\n","_postman_id":"51bf77fa-e992-43f5-8bb5-129b8c142e06"},{"name":"SCIM","item":[{"name":"Get Users","id":"fd47b722-2f96-478a-8a6d-e2c302e0af0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"url":"https://yourcompany.sendsafely.com/scim/v2/Users?startIndex=1&count=1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[{"key":"startIndex","value":"1"},{"key":"count","value":"1"}],"variable":[]}},"response":[{"id":"ed6ab631-c7b7-4bea-be3a-f278dc6d86dd","name":"Get Users Example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/scim/v2/Users?startIndex=1&count=1","host":["https://yourcompany.sendsafely.com/scim/v2"],"path":["Users"],"query":[{"key":"startIndex","value":"1"},{"key":"count","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jul 2024 16:08:29 GMT"},{"key":"Content-Type","value":"application/scim+json;charset=utf-8"},{"key":"Content-Length","value":"359"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"null"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Service-Worker-Allowed","value":"/"},{"key":"Expires","value":"Tue, 03 Jul 2001 06:00:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":""},{"key":"X-WebKit-CSP","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\"\"],\n \"totalResults\": \"\",\n \"itemsPerPage\": \"\",\n \"startIndex\": \"\",\n \"Resources\": [\n {\n \"schemas\": [\"\"],\n \"id\": \"\",\n \"userName\": \"\",\n \"name\": {\n \"formatted\": \"\",\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"userLastLoggedInTimeStamp\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n }\n ]\n}"}],"_postman_id":"fd47b722-2f96-478a-8a6d-e2c302e0af0d"},{"name":"Create User","id":"c2442e0b-a3bf-4e8b-aa20-65b58cf3c373","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\"\n ],\n \"userName\": \"user@yourcompany.com\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"active\": true,\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": { \"isAdmin\": false }\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"03105581-084a-4b26-805e-00548898c46e","name":"Create User Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\"\"],\n \"userName\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jul 2024 16:11:24 GMT"},{"key":"Content-Type","value":"application/scim+json;charset=utf-8"},{"key":"Content-Length","value":"259"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"null"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Service-Worker-Allowed","value":"/"},{"key":"Expires","value":"Tue, 03 Jul 2001 06:00:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":""},{"key":"X-WebKit-CSP","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\"\"],\n \"id\": \"\",\n \"userName\": \"\",\n \"name\": {\n \"formatted\": \"\",\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"userLastLoggedInTimeStamp\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"}],"_postman_id":"c2442e0b-a3bf-4e8b-aa20-65b58cf3c373"},{"name":"Update User","id":"8f692ba5-3d1b-427c-81ed-af3393b534be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\"\n ],\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": { \"isAdmin\": false }\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users/user@yourcompany.com","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users","user@yourcompany.com"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"e34261ad-44a9-40a5-8f23-3961afce3e4f","name":"Update User Example","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\"\"],\n \"name\": {\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users/user@yourcompany.com"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jul 2024 16:11:24 GMT"},{"key":"Content-Type","value":"application/scim+json;charset=utf-8"},{"key":"Content-Length","value":"259"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"null"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Service-Worker-Allowed","value":"/"},{"key":"Expires","value":"Tue, 03 Jul 2001 06:00:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":""},{"key":"X-WebKit-CSP","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\"\"],\n \"id\": \"\",\n \"userName\": \"\",\n \"name\": {\n \"formatted\": \"\",\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"userLastLoggedInTimeStamp\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"}],"_postman_id":"8f692ba5-3d1b-427c-81ed-af3393b534be"},{"name":"Deactivate User","id":"0eb2d484-05bc-4312-82ff-cc72c2f8e831","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n ],\n \"Operations\": [\n {\n \"op\": \"replace\",\n \"value\": {\n \"active\": false\n }\n }\n ]\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users/user@yourcompany.com","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users","user@yourcompany.com"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"cb0ab96b-aebd-40d6-bb71-a088cf81b722","name":"Deactivate User Example","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n ],\n \"Operations\": [\n {\n \"op\": \"replace\",\n \"value\": {\n \"active\": false\n }\n }\n ]\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users/user@yourcompany.com"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jul 2024 16:11:47 GMT"},{"key":"Content-Type","value":"application/scim+json;charset=utf-8"},{"key":"Content-Length","value":"206"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"null"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Service-Worker-Allowed","value":"/"},{"key":"Expires","value":"Tue, 03 Jul 2001 06:00:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":""},{"key":"X-WebKit-CSP","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\"\"],\n \"id\": \"\",\n \"userName\": \"\",\n \"name\": {\n \"formatted\": \"\",\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"userLastLoggedInTimeStamp\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"}],"_postman_id":"0eb2d484-05bc-4312-82ff-cc72c2f8e831"}],"id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d04ba1cd-a766-454a-8759-3d9fc9798ad8"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"36a100e1-aa17-4656-b97a-ec9cd372df1b"}}],"_postman_id":"bc870cc8-430c-4372-a9ed-0fe177029cb9","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var sdk = require('postman-collection');","var path = pm.variables.get('baseUrl').substring(pm.variables.get('baseUrl').indexOf('/',8)) + \"/\" + new sdk.Url(request.url).toJSON().path.join(\"/\");","pm.variables.set(\"timestamp\", new Date().toISOString().substr(0, 19) + \"+0000\");","var body = \"\";","if (pm.request.hasOwnProperty('body') && pm.request.body.hasOwnProperty('raw')) {"," var bodyLines = pm.request.body.raw.split(\"\\n\");"," for (var i = 0; i < bodyLines.length; i++) {"," if (bodyLines[i].includes(\"//\"))"," {"," bodyLines[i] = bodyLines[i].substring(0,bodyLines[i].lastIndexOf(\"//\"));"," }"," body += bodyLines[i].trim();"," }","}","var data = pm.variables.get(\"ss-api-key\") + path + pm.variables.get(\"timestamp\") + body;","console.log(data);","var signature = CryptoJS.HmacSHA256(data, pm.variables.get(\"ss-api-secret\")).toString(CryptoJS.enc.Hex);","console.log(signature);","var signature2 = CryptoJS.HmacSHA256(data, pm.variables.get(\"ss-api-secret\")).toString(CryptoJS.enc.Base64);","toString(CryptoJS.enc.Hex);","console.log(signature2);","pm.variables.set(\"ss-api-signature\",signature);","pm.request.headers.upsert({key: 'ss-request-signature', value: signature });","pm.request.headers.upsert({key: 'ss-api-key', value: pm.variables.get(\"ss-api-key\") });","pm.request.headers.upsert({key: 'ss-request-timestamp', value: pm.variables.get(\"timestamp\") });","pm.request.body.raw = body;"],"id":"eff4df14-832f-4dce-b21e-03316a7e647d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5419a145-9ed1-440f-b312-f2093110d090"}}],"variable":[{"key":"baseUrl","value":"https://yourcompany.sendsafely.com/api/v2.0"},{"key":"ss-api-key","value":""},{"key":"ss-api-secret","value":""},{"key":"SCIMUsername","value":""},{"key":"baseSCIMUrl","value":"https://yourcompany.sendsafely.com/scim/v2"},{"key":"SCIMPassword","value":""}]}