{"info":{"_postman_id":"825f0f90-c616-49b6-9d8b-20ad52d2cdf7","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":"825f0f90-c616-49b6-9d8b-20ad52d2cdf7","publishedId":"2sBY4TpJ6Q","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-07-31T17:03:01.000Z"},"item":[{"name":"package","item":[{"name":"{package Id}","item":[{"name":"recipient","item":[{"name":"{recipient Id}","item":[{"name":"Get Recipient","id":"9d419047-1170-471d-99cb-f1eac37c30b2","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":"0d9059cc-b01d-4f9e-889d-3ec5e95a5419","type":"any","value":"","key":"packageId"},{"id":"0acc2f63-94f0-4155-bc1b-0ccef5544d81","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"030c66fd-79ef-480a-ba6c-8f35e302d056","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":"9d419047-1170-471d-99cb-f1eac37c30b2"},{"name":"Update Recipient","id":"bb4f27bb-7ba3-4007-bb35-28b5bd9f5512","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":"3d514dd5-aa34-4961-916a-ca744146de82","type":"any","value":"","key":"packageId"},{"id":"ab9fb297-9383-4f22-8359-fde354a0374c","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"b2cd240f-710d-4833-a4ca-e02044fa2d74","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":"bb4f27bb-7ba3-4007-bb35-28b5bd9f5512"},{"name":"Remove Recipient","id":"6506b7e5-a539-4698-87cb-72942b56d9c0","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":"5865b856-1285-44d2-8278-4240f0ca858c","type":"any","value":"","key":"packageId"},{"id":"9a71f9ed-f19e-411a-a4b4-364f94729cd5","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"910a2596-4939-4c35-93bc-1c5f4d9bbcd6","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":"6506b7e5-a539-4698-87cb-72942b56d9c0"},{"name":"Get Recipient Public Keys","id":"dcd627a3-0b38-4786-a4af-a24fb8f4b74d","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":"f76b7ea2-bbfd-42b0-b15a-14ff1f7e982b","type":"any","value":"","key":"packageId"},{"id":"8bb8e31f-de8b-4b4c-b4c7-23fc997e6581","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"6cc5824d-b971-4ebd-8821-7ef7faa0e480","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":"dcd627a3-0b38-4786-a4af-a24fb8f4b74d"},{"name":"Get Recipient Permissions","id":"d67a1502-b690-44fe-bf68-9fe8d7b117de","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":"8220e042-3784-42bd-a573-618904c471a1","type":"any","value":"","key":"packageId"},{"id":"db3fa42d-5bdc-41e5-b6df-83234803370d","type":"any","value":"","key":"recipientId"}]}},"response":[],"_postman_id":"d67a1502-b690-44fe-bf68-9fe8d7b117de"}],"id":"2ce7fcdd-2077-4e48-b7bd-e7d2635ea60d","description":"

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

\n","_postman_id":"2ce7fcdd-2077-4e48-b7bd-e7d2635ea60d"},{"name":"Add Recipient","id":"4b87a186-5b45-4013-86c0-fc584a03b82f","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":"c91ef752-aa7e-4830-90e1-9553fe96975f","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"f3613d1b-88ae-40f2-966d-28e204681fd6","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":"4b87a186-5b45-4013-86c0-fc584a03b82f"},{"name":"Add Recipients","id":"66c67e79-c60d-473d-9d77-35d6d849433f","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":"4a151bcc-cb09-4ae5-a087-e68c75344ae3","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"f384194a-1fc5-46c3-818a-ad6235933e7e","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":"66c67e79-c60d-473d-9d77-35d6d849433f"},{"name":"Delete Recipients","id":"bda7fcfb-e995-4951-a967-e07a7452561f","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":"229b0f56-1c87-457a-9c98-3294406ac842","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"8e1c55a7-407a-482f-96d4-026777d5774e","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":"bda7fcfb-e995-4951-a967-e07a7452561f"}],"id":"0228f44f-d61f-4a76-b6c2-ed93729ab42e","description":"

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

\n","_postman_id":"0228f44f-d61f-4a76-b6c2-ed93729ab42e"},{"name":"file","item":[{"name":"{file Id}","item":[{"name":"Get File Upload Urls","id":"8ed6428e-c016-41d2-b73d-5d5195ec573e","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":"bcee8b0b-2bdb-4bb5-bdd4-3dd897cc49de","type":"any","value":"","key":"packageId"},{"id":"c7186159-4dc8-42cf-a124-08669ef6fa4a","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"e9cd8392-2eba-4da5-aed9-8db673958fc4","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":"8ed6428e-c016-41d2-b73d-5d5195ec573e"},{"name":"Set File Upload Complete","id":"4641cc1e-47ed-4b2c-9ac4-625287e58795","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":"8b989572-5ea2-43c4-88b8-91534b494891","type":"any","value":"","key":"packageId"},{"id":"07ebc25e-8fa5-4e4c-b6dd-c70c4148ebcf","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"93d54da4-7d28-4a4f-937d-cb8242402f59","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":"4641cc1e-47ed-4b2c-9ac4-625287e58795"},{"name":"Get File Download Urls","id":"18c18fa5-7a3f-4f33-b623-208e227e9652","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":"6683afb6-1973-4aaa-af89-25e740a398bc","type":"any","value":"","key":"packageId"},{"id":"0b383ef7-dbbf-402e-87b8-93407f984486","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"5a2f75f3-d078-4fd1-b4ac-6ee6234d599f","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":"18c18fa5-7a3f-4f33-b623-208e227e9652"},{"name":"Copy File To Workspace","id":"429844b0-3ae2-416d-a75b-24ad491c7e87","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":"4d4854bd-03e3-41a6-8ce2-d46b63e77bff","type":"any","value":"","key":"packageId"},{"id":"c91104bc-042e-471f-8932-cfef11e6dbce","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"6426af47-aace-4065-96eb-c03d935dcea0","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":"429844b0-3ae2-416d-a75b-24ad491c7e87"},{"name":"Update File","id":"d051ac7c-3f03-495c-92ba-672067f8cf05","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":"3a7b7174-a2ca-4255-8bf6-1fa3cca3187d","type":"any","value":"","key":"packageId"},{"id":"292fd96e-0ec4-4cd9-a629-e639a38cb521","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"d4d6752d-6a4b-4c7e-a06e-bcbe76eb1f31","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":"d051ac7c-3f03-495c-92ba-672067f8cf05"},{"name":"Delete Package File","id":"e746b8c7-a7bb-467f-bfe0-9140aec5c890","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":"ddc1ef9b-1970-49c2-bd1d-a070153453d2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"c2e575a4-c5a4-49a3-bd0b-d3be3d0e7695","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"cd0b7f85-f2c3-4dbc-b88f-f49551f91973","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":"e746b8c7-a7bb-467f-bfe0-9140aec5c890"},{"name":"Get File Information","id":"4c283995-9fda-430a-9468-ecf37efed6db","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":"3106a9f9-927c-4534-ba35-cb6089390909","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"3d6af7b8-532b-4c8d-88cd-ff3e06604290","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"ffa45f5f-d751-4233-9f50-5b469813fd2c","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":"4c283995-9fda-430a-9468-ecf37efed6db"}],"id":"a84cc89e-7da3-4005-b80f-ad506551c5b4","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":"a84cc89e-7da3-4005-b80f-ad506551c5b4"},{"name":"Add File","id":"16cac9f8-ecb1-4b3f-b0a7-8aac4f5e6bee","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":"834acd12-9cbd-4801-a8ac-533238865f12","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"6a9bba25-58c3-448e-a5ba-77855db9082e","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":"16cac9f8-ecb1-4b3f-b0a7-8aac4f5e6bee"}],"id":"2858e5c5-160b-4861-95ab-cf5a35ae8b8a","description":"

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

\n","_postman_id":"2858e5c5-160b-4861-95ab-cf5a35ae8b8a"},{"name":"link","item":[{"name":"{public key Id}","item":[{"name":"Get Keycode","id":"d59c2f9c-5c0f-4631-a4c1-034361b3786e","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":"691ae8a3-3304-4936-977d-c7af8afea2b4","type":"any","value":"","key":"packageId"},{"id":"50d1584b-680c-4efd-b333-ded3505159ef","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"d5acf2dd-0c86-4ff0-add5-476b92aab9c2","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":"d59c2f9c-5c0f-4631-a4c1-034361b3786e"},{"name":"Add Keycode","id":"ec2f9265-a71b-455a-b2af-1702f73b177c","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":"511d7a26-5ad0-46dc-baf3-1a394543d7e9","type":"any","value":"","key":"packageId"},{"id":"9c24e793-a942-425b-8c20-a590412ad4a0","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"0b0cf033-cbce-475d-9ae2-bc6db1a56254","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":"ec2f9265-a71b-455a-b2af-1702f73b177c"}],"id":"49a5c89b-1447-48fb-bdf4-a8443ce49046","description":"

The unique identifier for a specific trusted browser public key.

\n","_postman_id":"49a5c89b-1447-48fb-bdf4-a8443ce49046"}],"id":"7a4ef087-548f-4224-a101-d5c65693df0a","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":"7a4ef087-548f-4224-a101-d5c65693df0a"},{"name":"directory","item":[{"name":"{directory Id}","item":[{"name":"permissions","item":[{"name":"Delete Directory Permission","id":"6811c0cf-b9e3-4ae0-9bba-37b76be725ad","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":"f20d214c-5311-4764-b747-e26bfb0fd944","type":"any","value":"","key":"packageId"},{"id":"38cd52b9-515c-4827-9232-0ca833edfb0b","type":"any","value":"","key":"recipientId"},{"id":"bdd00b32-1e39-4929-9c34-0a2b66a9cdef","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"6811c0cf-b9e3-4ae0-9bba-37b76be725ad"},{"name":"Add Directory Permission","id":"0f409a4a-99be-4948-9b15-085de6bf907d","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":"0d1499df-52cd-422a-8780-70a8091b683c","type":"any","value":"","key":"packageId"},{"id":"025daef6-69c6-4841-9853-d9f16581eeac","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"0f409a4a-99be-4948-9b15-085de6bf907d"},{"name":"Get Directory Permissions","id":"1094341e-b9bd-46c9-b525-6c08317eebe5","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":"a3724b80-2b04-471b-aac6-897f10a438ff","type":"any","value":"","key":"packageId"},{"id":"3fd8bd82-b4a8-4adf-8726-539e1598e525","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"1094341e-b9bd-46c9-b525-6c08317eebe5"}],"id":"8c148017-f8d4-4632-bddf-35af897c4b20","description":"

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

\n","_postman_id":"8c148017-f8d4-4632-bddf-35af897c4b20"},{"name":"file","item":[{"name":"{file Id}","item":[{"name":"Get File Download Urls From Directory","id":"d1c0aef1-cbf1-4fcd-a3e6-944cdcefdac2","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":"7fad206c-9f29-42a6-ab97-b11a52e1f7cd","type":"any","value":"","key":"packageId"},{"id":"97a65fc9-315f-4e38-9c64-4f3bdf3f4859","type":"any","value":"","key":"directoryId"},{"id":"2ed965dc-f296-4681-b7b2-d19f525369cd","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"bd7d25f3-e9a1-4370-b5d5-56aa8d4acc8e","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":"d1c0aef1-cbf1-4fcd-a3e6-944cdcefdac2"},{"name":"Delete File From Directory","id":"105b11c4-370b-4b92-889f-370997ca030e","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":"0c83cd3d-8e51-43b7-bf81-b9e13c2ab797","type":"any","value":"","key":"packageId"},{"id":"1eaaffca-911e-4f9e-a076-91fcc358d8e4","type":"any","value":"","key":"directoryId"},{"id":"3fdfbe38-a784-4a25-b588-115d6def2f7a","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"bbe37f3a-3b12-4e5e-938e-8c36ea1fdf56","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":"105b11c4-370b-4b92-889f-370997ca030e"},{"name":"Get File From Directory","id":"362f52ea-4c2f-434b-83cc-1156e35ba9fe","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":"b7c728c2-e90c-4103-ae33-72140ffceeba","type":"any","value":"","key":"packageId"},{"id":"b258247a-c4f3-4522-8397-177bd2c56bd0","type":"any","value":"","key":"directoryId"},{"id":"3a79f338-93af-40d7-a6f2-eccea54fc5de","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"534fdde3-bade-40c3-82a9-6195ccb55c6c","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":"362f52ea-4c2f-434b-83cc-1156e35ba9fe"}],"id":"2ee801e4-30fa-4647-998b-c02d8c4a232a","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":"2ee801e4-30fa-4647-998b-c02d8c4a232a"}],"id":"1ac3c3d5-50e8-481c-a181-5eb0f1b9f1c4","description":"

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

\n","_postman_id":"1ac3c3d5-50e8-481c-a181-5eb0f1b9f1c4"},{"name":"Delete Directory","id":"93e544a3-7600-4de1-9b07-dcbada4d4c03","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":"52671304-e248-41ea-bc97-ecce6c6b7956","type":"any","value":"","key":"packageId"},{"id":"cdb1cabd-49b6-438a-99da-9d41f30aaeff","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"cc3fa27e-bd17-416b-b9fc-ddde8007396f","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":"93e544a3-7600-4de1-9b07-dcbada4d4c03"},{"name":"Get Directory","id":"68bcb23d-f375-490a-87c7-5abc1aaeaa7e","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":"cbfa27d4-da2c-46db-af21-7b23771a219d","type":"any","value":"","key":"packageId"},{"id":"ec7bcc80-5d13-4b33-bf4d-3b33adfa97d6","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"8ff8bb3d-a30a-4aa8-93ec-13b2d2d8a969","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":"68bcb23d-f375-490a-87c7-5abc1aaeaa7e"},{"name":"Rename Directory","id":"fd3b3c8d-553a-4b56-bfce-a3ec7c717ae7","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":"6a6b2dd0-7393-480e-aad0-e0e5166e3fc0","type":"any","value":"","key":"packageId"},{"id":"16d97be9-7831-448a-ab17-40ae99955892","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"18549da1-9814-4ec3-8a82-fb22e1f5e15b","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":"fd3b3c8d-553a-4b56-bfce-a3ec7c717ae7"},{"name":"Create Subdirectory","id":"d9598ce3-111a-400b-ab4b-6358fbeecdbe","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":"{\"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":"7d857b16-8a4c-4912-9853-4de135e07d6f","type":"any","value":"","key":"packageId"},{"id":"bcaa6e96-8b44-4a8d-9e6f-59268e86b6dc","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"efece724-6afd-462b-bfb3-dcd391a9c012","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"}],"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":"d9598ce3-111a-400b-ab4b-6358fbeecdbe"},{"name":"Move Workspace File","id":"aae734b2-d565-4725-875c-fad33c7c5698","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":"74aebc34-a84f-403a-8c69-3f9c09d82261","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"4dce5776-b509-4a02-ac76-b479b69e7123","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"directoryId"},{"id":"6632ec77-3851-48c1-a7f7-92febe6f467b","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"8b618354-9303-4334-809c-db8f4beaf753","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":"aae734b2-d565-4725-875c-fad33c7c5698"}],"id":"2f89df10-acd7-4fc1-8c30-fbeac0258daf","description":"

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

\n","_postman_id":"2f89df10-acd7-4fc1-8c30-fbeac0258daf"}],"id":"c598e5a9-1f6b-4ee9-a7b2-2e2d0c7be3fc","description":"

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

\n","_postman_id":"c598e5a9-1f6b-4ee9-a7b2-2e2d0c7be3fc"},{"name":"collaborator","item":[{"name":"Get Collaborators","id":"c045ae0c-e52a-438a-b94b-7a3094303c07","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":"43f3ac57-d428-4243-8eed-80286091c471","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c5091edf-a550-44bd-97ff-01ef3f5b32fd","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":"c045ae0c-e52a-438a-b94b-7a3094303c07"}],"id":"52cddb6a-86cb-49ae-bdff-0135c162dacb","_postman_id":"52cddb6a-86cb-49ae-bdff-0135c162dacb","description":""},{"name":"Get Package Information","id":"e1875aa7-8f5a-408e-ac8f-e3b58f728225","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":"6ef63643-b915-4a54-985c-588faff2b834","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"b6091d12-cc88-4229-8613-1012f4496196","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\": \"\", \"packageParentId\": \"\", \"packageCode\": \"\", \"serverSecret\": \"\", \"recipients\": [ { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": [], \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\", \"smsAuth\": \"\", \"isGuest\": \"\", \"managerStatus\": \"\" }, { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": [], \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\", \"smsAuth\": \"\", \"isGuest\": \"\" } ], \"contactGroups\": [], \"files\": [ { \"fileId\": \"\", \"fileName\": \"\", \"fileSize\": \"\", \"parts\": \"\", \"fileUploaded\": \"\", \"fileUploadedStr\": \"\", \"fileVersion\": \"\", \"createdByEmail\": \"\", \"fileState\": \"\" } ], \"directories\": [], \"approverList\": [], \"needsApproval\": \"\", \"state\": \"\", \"passwordRequired\": \"\", \"life\": \"\", \"isVDR\": \"\", \"isArchived\": \"\", \"packageSender\": \"\", \"packageTimestamp\": \"\", \"rootDirectoryId\": \"\", \"totalDirectories\": \"\", \"totalFiles\": \"\", \"allowReplyAll\": \"\", \"packageDescriptor\": \"\", \"packageDescriptorLabel\": \"\", \"packageType\": \"\", \"addWatermark\": \"\", \"pdfViewOnly\": \"\", \"packageContainsMessage\": \"\", \"packageMessageState\": \"\", \"response\": \"\" }"}],"_postman_id":"e1875aa7-8f5a-408e-ac8f-e3b58f728225"},{"name":"Update Package","id":"7fe99aa5-aac1-41a9-851e-07f707c92993","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":"81cd9fab-a81e-4c6a-9ab7-867443c451f1","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"cf817996-a577-402e-9792-c0ca7d861502","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":"7fe99aa5-aac1-41a9-851e-07f707c92993"},{"name":"Delete Package","id":"d8e1b2ce-e75d-4570-b278-b8e0b8adff40","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":"f5f5e509-3008-484a-b7f0-d77fcd9b9430","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c0789115-0a60-4d71-aa4b-9c892b28890b","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":"d8e1b2ce-e75d-4570-b278-b8e0b8adff40"},{"name":"Finalize Package","id":"253237d8-c05e-4acc-a2c4-87bf63465b70","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":"c393aaf0-5b99-403c-ad48-1f850694f724","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"29cbe474-a819-4861-9163-9288189d8c1d","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":"253237d8-c05e-4acc-a2c4-87bf63465b70"},{"name":"Add Encrypted Message","id":"ea1a447a-71a1-416d-a4bb-6d334fab974b","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":"976e1829-3b3a-4671-ad4e-efeeae272c9c","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"8c9e5376-5215-4687-8072-6d74e2e58dec","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":"ea1a447a-71a1-416d-a4bb-6d334fab974b"},{"name":"Get Package Public Keys","id":"4b19d88a-d173-46b1-a2ed-81791339cbd6","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":"857c3e04-8648-4242-be95-3ed0774009af","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"be85ec56-b2c6-4c8e-98eb-571925cf455b","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":"4b19d88a-d173-46b1-a2ed-81791339cbd6"},{"name":"Get Workspace Activity Log","id":"a8b7ca29-b92e-41e0-80e2-2c89356140a1","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":"56e3461c-a9bc-48b5-94c4-917c83dcaee5","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"feeb131c-aef3-4dec-b393-79d021c37c01","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":"a8b7ca29-b92e-41e0-80e2-2c89356140a1"},{"name":"Move Directory","id":"8565ac41-6baf-44f3-b4cb-c6e9c320ee19","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":"a1e59ce2-b546-4b8c-8c21-85413bedea9f","type":"any","value":"","key":"packageId"},{"id":"4dbf590c-f520-4f80-b057-98b741be3622","type":"any","value":"","key":"sourcedirectoryId"},{"id":"5b0f80d7-cb32-4e14-a87f-187647361dc7","type":"any","value":"","key":"targetdirectoryId"}]}},"response":[{"id":"23ba58a6-6ca9-4fd4-be2a-e6486b8ac816","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":"8565ac41-6baf-44f3-b4cb-c6e9c320ee19"},{"name":"Get Package Permissions","id":"da42258a-d3c7-477c-b2cd-2caccf5b57ce","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":"2dffee7a-6dda-4b92-a690-828c9da7fd37","type":"any","value":"","key":"packageId"}]}},"response":[],"_postman_id":"da42258a-d3c7-477c-b2cd-2caccf5b57ce"},{"name":"Delete Contact Group from Package","id":"4c1b5636-ca4d-4ea8-a3ef-29e83039400f","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":"2ee1c342-46ac-4e3a-95fe-4bade20b35ab","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"c9793a95-d8c7-4ed4-aa54-a0a76e01c40a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"groupId"}]}},"response":[{"id":"3a96a88e-f5b3-43dd-bfe3-539ea62cfc91","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":"4c1b5636-ca4d-4ea8-a3ef-29e83039400f"},{"name":"Delete Temp Package","id":"9b530473-8226-40cd-a034-d9fbf7418048","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":"971895c4-ab81-4cce-9a84-70f2a86f6624","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"b6062aed-79f7-4cbe-80ac-e31135a354ba","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":"9b530473-8226-40cd-a034-d9fbf7418048"},{"name":"Add Contact Group to Package","id":"488abc69-24f0-486f-8d3e-db681e620fc6","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":"5f9cd4cf-2cdc-4697-9b2e-4c4714257180","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"dc47d7fe-6e98-4bce-98bd-08fe333f5ee7","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"groupId"}]}},"response":[{"id":"1e501cf3-69ae-4111-a04a-09c912877d6a","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":"488abc69-24f0-486f-8d3e-db681e620fc6"},{"name":"Get Package Message","id":"5cb50936-8adb-4aee-b189-a3195acd54a7","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":"c43b2164-e52f-47de-b59c-748062a2e293","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"913e9fd4-dc6b-4da1-aff5-04326e95d755","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"checksum"}]}},"response":[{"id":"0af379e5-8959-4627-a522-0c8a4eda9d78","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":"5cb50936-8adb-4aee-b189-a3195acd54a7"},{"name":"Bulk Package Transfer Ownership","id":"f4f0c882-fc07-423c-b1b6-c64a928ba449","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":"2bef2dcc-6688-437b-88e5-78ac9d9d32b8","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":"f4f0c882-fc07-423c-b1b6-c64a928ba449"}],"id":"e040c19f-57f7-4f54-9209-85a684731943","description":"

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

\n","_postman_id":"e040c19f-57f7-4f54-9209-85a684731943"},{"name":"organization","item":[{"name":"Get Organization Packages [DEPRECATED]","id":"59f9fbaa-a4f2-4079-bd4c-515ad791438f","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":"f7bee770-08d2-42d6-9f33-a0df82dfe1db","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":"59f9fbaa-a4f2-4079-bd4c-515ad791438f"},{"name":"Organization Package Search","id":"cf4c1aeb-6f58-43a6-92eb-82d5423ee452","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":"4d9cf3d3-971a-4f04-88db-38ba68033a88","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":"cf4c1aeb-6f58-43a6-92eb-82d5423ee452"}],"id":"47b9e593-9cf4-446c-bcd6-2e2899241cfd","description":"

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

\n","_postman_id":"47b9e593-9cf4-446c-bcd6-2e2899241cfd"},{"name":"Create Package","id":"d28fba9c-ddfd-42d9-a1b8-1e0b3dc6c6ff","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":"283d3d82-b2ec-4fdd-84a7-e1fbc685ee6f","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":"d28fba9c-ddfd-42d9-a1b8-1e0b3dc6c6ff"},{"name":"Get Received Packages","id":"87c9a8b6-acfb-4a07-8edf-6d3d70c10264","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":"86dd6a5e-1e1f-45c3-a972-fba9730154be","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":"87c9a8b6-acfb-4a07-8edf-6d3d70c10264"},{"name":"Get Archived Packages","id":"a3d9a4ec-4799-4128-80df-6190a468e426","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":"cd206e09-da47-41bd-bcc6-d7c8d3ad6bc2","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":"a3d9a4ec-4799-4128-80df-6190a468e426"},{"name":"Get Sent Packages","id":"6956754d-306b-4b47-89f4-1900fc160983","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":"eb4f1e0a-9a44-4218-bcd3-87a5989ff2e0","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":"6956754d-306b-4b47-89f4-1900fc160983"},{"name":"Search Package","id":"41b9d1cd-e86a-479d-9e4c-88aaa66a92a6","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":"41b9d1cd-e86a-479d-9e4c-88aaa66a92a6"},{"name":"Get Workspace Packages","id":"f5a87044-b5eb-452e-b177-62e78bcd6e78","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":"f5a87044-b5eb-452e-b177-62e78bcd6e78"},{"name":"Bulk Add Recipient","id":"543d6588-b6c1-447f-8000-bf8e18ec111b","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":"d9ee4ac9-8a91-4487-b19d-672316f9e988","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":"543d6588-b6c1-447f-8000-bf8e18ec111b"},{"name":"Bulk Remove Recipient","id":"550c5df9-947d-4f9b-9d2f-5ac7c031e9bb","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":"8c9ef098-1e36-4b67-a60b-56f6a600162d","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":"550c5df9-947d-4f9b-9d2f-5ac7c031e9bb"}],"id":"58a692e1-f783-44ec-bd11-02aad25f891d","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":"58a692e1-f783-44ec-bd11-02aad25f891d"},{"name":"user","item":[{"name":"api-key","item":[{"name":"Generate API Key","id":"6c6f11c4-5b55-4a0e-b99a-152c12f4dde0","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":"{\"description\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/api-key/","description":"

Generates a new API Key (apiKey) + Secret (privateKey) for the authenticated user; these form the credential pair for HMAC-signed API requests. Store both securely. Use this endpoint to programmatically rotate API keys.

\n

The request body must contain a description value to label the new key.

\n","urlObject":{"path":["user","api-key",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"6b5a4df6-fa26-418f-bd68-2e98d3509ae6","name":"Generate API 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"}],"body":{"mode":"raw","raw":"{\"description\": \"rotation-key\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/api-key/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"id\": \"\", \"note\": \"\", \"apiKey\": \"\", \"privateKey\": \"\", \"lastUsed\": \"\", \"response\": \"\"}"}],"_postman_id":"6c6f11c4-5b55-4a0e-b99a-152c12f4dde0"},{"name":"Revoke API Key","id":"a15fd71e-4263-4cac-a31a-237190804a20","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":"{\"apiKeyId\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/api-key/","description":"

Revokes an existing API Key belonging to the authenticated user. Provide the apiKeyId of the key to revoke in the request body. Once revoked, the key can no longer be used to authenticate requests. Users may only revoke keys they own.

\n","urlObject":{"path":["user","api-key",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"a2f13a31-85c3-4cec-bef8-e833a1f3b0dc","name":"Revoke API 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"}],"body":{"mode":"raw","raw":"{\"apiKeyId\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/api-key/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"response\": \"\", \"message\": \"\"}"}],"_postman_id":"a15fd71e-4263-4cac-a31a-237190804a20"}],"id":"5d6d4edd-eeea-4974-ae69-a13f11ac77dc","description":"

Endpoints for managing the API Keys belonging to the authenticated user. Use these for programmatic API key rotation: call Generate API Key to create a new key, switch your client to the new credentials, then call Revoke API Key with the apiKeyId of the old key.

\n","_postman_id":"5d6d4edd-eeea-4974-ae69-a13f11ac77dc"},{"name":"dropzone-recipients","item":[{"name":"Get Dropzone Recipients","id":"908ba994-813f-46bf-aa2d-d6569be1ce14","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":"6bd3d6da-a11d-4545-9cb9-e060acdc7e3a","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":"908ba994-813f-46bf-aa2d-d6569be1ce14"},{"name":"Add Dropzone Recipients","id":"73440bb1-bf79-49f1-b9b2-f63f41669a4f","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\": \"\", \"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":"79d8673e-ed3a-443b-9925-830e4695d6c8","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"}],"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":"73440bb1-bf79-49f1-b9b2-f63f41669a4f"},{"name":"Remove Dropzone Recipient","id":"c77ee554-f02f-4584-b0ec-ff8474b0bc11","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":"1d5c42c6-37d7-44db-aed3-ecb36eda94fb","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":"c77ee554-f02f-4584-b0ec-ff8474b0bc11"},{"name":"Get Dropzone Recipients By DropzoneId","id":"3285aa72-9aac-44b2-a98a-ceb478c1ff74","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":"fb76474b-d4b1-425c-b29e-256c34ad818b","type":"any","value":"dropzoneId","key":"publicKey"}]}},"response":[],"_postman_id":"3285aa72-9aac-44b2-a98a-ceb478c1ff74"}],"id":"46665957-99b4-49fb-8584-57579321b52a","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":"46665957-99b4-49fb-8584-57579321b52a"},{"name":"{user Id}","item":[{"name":"Update Dropzone Configuration","id":"1df659e5-dc7c-4017-b104-8c97c9f9bb3b","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":"{\"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":"de0df756-a267-41b8-ad7b-c44dc39a3b4e","type":"any","value":"","key":"userId"}]}},"response":[{"id":"cf5c8255-e6cd-4640-853f-a9274009bf2c","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"}],"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":"1df659e5-dc7c-4017-b104-8c97c9f9bb3b"}],"id":"6c4cfb97-8acf-442f-bb12-59710ba366c4","description":"

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

\n","_postman_id":"6c4cfb97-8acf-442f-bb12-59710ba366c4"},{"name":"Get User Information","id":"3ee78bc6-1ee6-4086-a7c9-0671f0bb3c17","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":"56373589-e594-4c20-8194-049bf3390dd4","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":"3ee78bc6-1ee6-4086-a7c9-0671f0bb3c17"},{"name":"Get User Contact Groups","id":"4fbfe074-0fd3-414f-940a-6f43482ea219","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":"88cde128-ff29-4c16-9b55-ad3c1a3db733","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":"4fbfe074-0fd3-414f-940a-6f43482ea219"}],"id":"9620d4e7-bc7d-4937-a3a4-40fa8f9bc892","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":"9620d4e7-bc7d-4937-a3a4-40fa8f9bc892"},{"name":"group","item":[{"name":"{group Id}","item":[{"name":"Get Contact Group","id":"168f076f-a542-4b26-a80a-85b89c5d3a4c","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":"2f728a25-f70e-46a2-a57e-eb80a4574e51","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"88cfadfc-0373-45f0-aaf8-8f30f5227417","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":"168f076f-a542-4b26-a80a-85b89c5d3a4c"},{"name":"Delete Contact Group","id":"fa73d37e-4d2c-41a5-bf3e-41d375e35985","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":"dda2a509-9373-490d-a386-15a96caef1bf","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"62627344-500b-4262-911f-34a9b8fdf216","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":"fa73d37e-4d2c-41a5-bf3e-41d375e35985"},{"name":"Add Contact Group Member","id":"1fcc5352-4143-4c11-b3ff-6c4652982b21","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":"e5ddd455-70d1-4e69-b889-5819a8166e6f","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"e884a59f-d977-4389-bcb2-a71710f6f72a","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":"1fcc5352-4143-4c11-b3ff-6c4652982b21"},{"name":"Remove Contact Group Member","id":"50dbb261-8b46-4737-ba45-944867c2de7e","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":"c233a851-688b-4208-be93-5d34ce9417e1","type":"any","value":"","key":"groupId"},{"id":"2ef1e8b6-3105-4ca9-a715-42b3cd9d1581","type":"any","value":"","key":"userId"}]}},"response":[{"id":"bb0822e1-1215-464f-9ccf-2e5a08755127","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":"50dbb261-8b46-4737-ba45-944867c2de7e"}],"id":"b07da97a-f9a5-4b89-8f65-125d6ff7a9b8","description":"

The unique identifier for a specific contact group.

\n","_postman_id":"b07da97a-f9a5-4b89-8f65-125d6ff7a9b8"},{"name":"Create Contact Group","id":"420f494d-b1c1-4fe9-aa23-f39c2b0ff18d","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":"eb41c51a-0515-442c-a5cd-717da194673c","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":"420f494d-b1c1-4fe9-aa23-f39c2b0ff18d"}],"id":"3ccd9020-aa0b-43c8-8fa4-13318094800f","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":"3ccd9020-aa0b-43c8-8fa4-13318094800f"},{"name":"public-key","item":[{"name":"{public Key Id}","item":[{"name":"Delete Public Key","id":"cd509989-7be3-467a-82ee-5d692137e531","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":"0e716b2f-926b-41f8-8650-6a6f22f4d42d","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"b9ddde35-1397-4856-af87-35fc8e7ddbdc","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":"cd509989-7be3-467a-82ee-5d692137e531"},{"name":"Get Public Key by ID","id":"414a8089-0353-41bf-96e4-b685c14e00d5","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":"b51a7561-a2ef-4469-aab4-c3f15b11d89a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"982736c3-277e-4f2c-b80a-5a7626690153","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":"414a8089-0353-41bf-96e4-b685c14e00d5"}],"id":"ebd35111-1e62-474c-b239-4372fab2507d","description":"

The unique identifier for a specific trusted browser public key.

\n","_postman_id":"ebd35111-1e62-474c-b239-4372fab2507d"},{"name":"Add Public Key","id":"526d299f-bdf8-490e-8d47-160decb82ac8","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":"{\"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":"952676b1-96c2-4e2b-b160-f098e934da90","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"}],"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":"526d299f-bdf8-490e-8d47-160decb82ac8"}],"id":"e91802b0-59a0-4265-b847-020cd459abe0","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":"e91802b0-59a0-4265-b847-020cd459abe0"},{"name":"enterprise","item":[{"name":"security-groups","item":[{"name":"Get Security Groups","id":"1a1416f1-b30e-4323-a08b-c86c1af3945a","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":"da632032-9d34-40a3-9032-aa65f474a511","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":"1a1416f1-b30e-4323-a08b-c86c1af3945a"},{"name":"Get Security Groups By Id","id":"3b768a02-821d-4c07-a488-50764212ffac","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":"0797376d-4c6f-4be6-b074-afc6298e1af7","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":"3b768a02-821d-4c07-a488-50764212ffac"},{"name":"Add Security Groups Member","id":"ef5cbc62-55b8-4c79-8118-54682cfaad9b","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":"a59bfca3-a106-46f9-af44-be9a5e7c21a6","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":"ef5cbc62-55b8-4c79-8118-54682cfaad9b"},{"name":"Delete Security Groups Member","id":"0f951e81-0a2c-475e-ab16-7ce2cb48f0a6","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":"fabbb676-474a-46e3-affb-b73548bc834c","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":"0f951e81-0a2c-475e-ab16-7ce2cb48f0a6"}],"id":"ebe5f26e-9277-4b89-96b9-b37c6d94f520","_postman_id":"ebe5f26e-9277-4b89-96b9-b37c6d94f520","description":""},{"name":"Get Enterprise Information","id":"a6dc8740-d2c8-40a7-ba0c-2e682adc266c","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":"bd08c33f-02a5-41f2-a008-382200d39310","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":"Text","header":[{"key":":status","value":200},{"key":"date","value":"Fri, 31 Jul 2026 13:12:26 GMT"},{"key":"content-type","value":"application/json;charset=utf-8"},{"key":"content-length","value":"2380"},{"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":"default-src 'none'; frame-src https://static-corp.sendsafely.com https://content.googleapis.com https://docs.google.com/ 'self' blob: https://bid.g.doubleclick.net https://www.google.com sendsafely: https://analytics-frame.sendsafely.com https://www.recaptcha.net https://static-demo.sendsafely.com https://app.sendsafely.com https://js.stripe.com;connect-src 'self' ; script-src 'self' https://static-demo.sendsafely.com https://www.google.com https://www.gstatic.com https://accounts.google.com https://apis.google.com https://content.googleapis.com https://ssl.gstatic.com https://www.recaptcha.net https://ssl.google-analytics.com https://api.stripe.com https://js.stripe.com https://www.googleadservices.com https://www.googletagmanager.com https://googleads.g.doubleclick.net https://js.hs-analytics.net https://js.hsforms.net https://forms.hubspot.com https://api.hubapi.com https://internal.hubapi.com ; style-src 'self' 'unsafe-inline'; font-src 'self'; manifest-src 'self'; object-src 'self' https://static-demo.sendsafely.com; child-src 'self'; media-src 'self' blob:; img-src 'self' https://cdn.zapier.com https://zapier.com https://app-static.sendsafely.com blob: data: https://www.google.com https://www.gstatic.com https://accounts.google.com https://apis.google.com https://content.googleapis.com https://ssl.gstatic.com https://ssl.google-analytics.com https://www.gravatar.com i0.wp.com i1.wp.com i2.wp.com i3.wp.com https://stats.g.doubleclick.net https://www.googleadservices.com https://googleads.g.doubleclick.net https://track.hubspot.com chrome-extension:;"},{"key":"x-webkit-csp","value":"default-src 'none'; frame-src https://static-corp.sendsafely.com https://content.googleapis.com https://docs.google.com/ 'self' blob: https://bid.g.doubleclick.net https://www.google.com sendsafely: https://analytics-frame.sendsafely.com https://www.recaptcha.net https://static-demo.sendsafely.com https://app.sendsafely.com https://js.stripe.com;connect-src 'self' ; script-src 'self' https://static-demo.sendsafely.com https://www.google.com https://www.gstatic.com https://accounts.google.com https://apis.google.com https://content.googleapis.com https://ssl.gstatic.com https://www.recaptcha.net https://ssl.google-analytics.com https://api.stripe.com https://js.stripe.com https://www.googleadservices.com https://www.googletagmanager.com https://googleads.g.doubleclick.net https://js.hs-analytics.net https://js.hsforms.net https://forms.hubspot.com https://api.hubapi.com https://internal.hubapi.com ; style-src 'self' 'unsafe-inline'; font-src 'self'; manifest-src 'self'; object-src 'self' https://static-demo.sendsafely.com; child-src 'self'; media-src 'self' blob:; img-src 'self' https://cdn.zapier.com https://zapier.com https://app-static.sendsafely.com blob: data: https://www.google.com https://www.gstatic.com https://accounts.google.com https://apis.google.com https://content.googleapis.com https://ssl.gstatic.com https://ssl.google-analytics.com https://www.gravatar.com i0.wp.com i1.wp.com i2.wp.com i3.wp.com https://stats.g.doubleclick.net https://www.googleadservices.com https://googleads.g.doubleclick.net https://track.hubspot.com chrome-extension:;"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"host\": \"\",\n \"systemName\": \"\",\n \"allowUndisclosedRecipients\": \"\",\n \"allowEncryptedMessages\": \"\",\n \"outlookBeta\": \"\",\n \"messageEncryption\": \"\",\n \"allowI18nAll\": \"\",\n \"linkColor\": \"\",\n \"allowSelfRegistration\": \"\",\n \"allowUnauthenticatedLinks\": \"\",\n \"enablePersonalUrls\": \"\",\n \"allowOAuthLogin\": \"\",\n \"requireTwoStepAuth\": \"\",\n \"restrictAccessByIp\": \"\",\n \"defaultFileExpirationDays\": \"\",\n \"fileExpirationMinDays\": \"\",\n \"fileExpirationMaxDays\": \"\",\n \"defaultDropzoneExpirationDays\": \"\",\n \"dropzoneExpirationMinDays\": \"\",\n \"dropzoneExpirationMaxDays\": \"\",\n \"requireDropzoneEmailVerification\": \"\",\n \"enableDropzoneAutoSubmission\": \"\",\n \"enterpriseMasterkey\": \"\",\n \"enableSamlSso\": \"\",\n \"response\": \"SUCCESS\"\n}"}],"_postman_id":"a6dc8740-d2c8-40a7-ba0c-2e682adc266c"},{"name":"Get Enterprise Contact Groups","id":"97590e55-c242-4c7f-a537-727fd1e976c8","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":"bf991454-7ad3-4d52-af38-0e2c99b7ee70","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":"97590e55-c242-4c7f-a537-727fd1e976c8"},{"name":"Get AuditLog","id":"167b062a-e2c4-439e-b32c-cc9e9e74d7a1","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":"36fc5ea6-ebad-4d2c-b6da-1274b797faf0","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/audit-logs/"},"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":"167b062a-e2c4-439e-b32c-cc9e9e74d7a1"}],"id":"bb2d5fe7-4ff8-4de6-868c-02a25fc6a9fc","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":"bb2d5fe7-4ff8-4de6-868c-02a25fc6a9fc"},{"name":"organization","item":[{"name":"Update IP Allow List","id":"7cedadc5-75d4-4b0d-a5ee-fc18d9581ba6","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":"eb31b8c9-0f40-46a7-aba0-98472eac0083","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":"7cedadc5-75d4-4b0d-a5ee-fc18d9581ba6"},{"name":"Get IP Allow List","id":"af2464ab-46d0-47dc-b132-e72749a3e0eb","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":"8de790ce-d0db-407a-a047-de0c48b26a8a","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":"af2464ab-46d0-47dc-b132-e72749a3e0eb"}],"id":"58643516-bbd5-46a1-98f7-957a4cee800e","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":"58643516-bbd5-46a1-98f7-957a4cee800e"},{"name":"sync","item":[{"name":"Sync Public Key","id":"6f4ac48a-34ca-4626-af4d-0bbc2ec000d6","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":"e1ee38e0-d5e5-421b-83f3-5216ef9f9a5d","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"3d27ecba-abea-49e8-ad76-7329e3311999","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":"6f4ac48a-34ca-4626-af4d-0bbc2ec000d6"}],"id":"27e1ee02-5b64-4b77-ad69-65b17cc9ad93","description":"

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

\n","_postman_id":"27e1ee02-5b64-4b77-ad69-65b17cc9ad93"},{"name":"recipient","item":[{"name":"Get Recipient Packages History","id":"f9293302-fe36-450e-a361-f1f3eaa2acaf","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":"71390be1-be62-43d3-9f13-a0cef67abc50","type":"any","value":"","key":"recipientEmail"}]}},"response":[{"id":"b1ed9688-9723-4d61-9e54-0050ddda791f","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":"f9293302-fe36-450e-a361-f1f3eaa2acaf"}],"id":"7853aaf5-6c88-4698-87c5-4e1d5ed726f1","description":"

Package recipient information

\n","_postman_id":"7853aaf5-6c88-4698-87c5-4e1d5ed726f1"},{"name":"config","item":[{"name":"Verify Credentials","id":"27f59525-3680-4363-ac5a-9e986a835e73","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":"aa5f2ac5-789a-43f2-b0d2-450f86527e1c","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":"27f59525-3680-4363-ac5a-9e986a835e73"}],"id":"2dc39382-10bc-4f4f-b3ca-d01aa0bc5d0f","description":"

API Configuration

\n","_postman_id":"2dc39382-10bc-4f4f-b3ca-d01aa0bc5d0f"},{"name":"Workflows","item":[{"name":"Workflows Callback","id":"9d2052f8-271d-4f39-9039-5d322f858ea6","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":"50ee4d7d-714f-46d7-8f8c-1b34e42752c0","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":"9d2052f8-271d-4f39-9039-5d322f858ea6"},{"name":"Add Workflow","id":"68fb07c9-2006-4837-9edd-5c7b036b7646","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":"21177360-502a-4a95-a97e-5891590532c9","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":"68fb07c9-2006-4837-9edd-5c7b036b7646"},{"name":"Add Enterprise Workflow","id":"f100dfff-ab46-4d06-b1f4-506114ac2bb0","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":"bc9083c7-67d0-47c3-9a9f-1042c53d349b","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":"f100dfff-ab46-4d06-b1f4-506114ac2bb0"},{"name":"Get Workflow","id":"b6b36946-d147-421b-a398-5c2189310f7e","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":"a69c09f4-8ea2-4f15-b6bf-fc349bee7e55","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"73bdd3ef-7ecc-46be-b188-b8d9a2c9c08d","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":"b6b36946-d147-421b-a398-5c2189310f7e"},{"name":"Get Workflows","id":"01f3decd-e8dd-4470-a88d-9e8764405f27","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":"fd0f12a5-bb0d-43c6-9c3f-5dd701e819f3","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":"01f3decd-e8dd-4470-a88d-9e8764405f27"},{"name":"Get Enterprise Workflows","id":"3e6f2692-b2ec-40a2-849f-f45981568ff8","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":"1b8e6a20-c21f-427b-bc3f-5e5edd2df850","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":"3e6f2692-b2ec-40a2-849f-f45981568ff8"},{"name":"Update Workflow","id":"680a6604-9686-42f7-9030-36c0803deafa","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":"ac352f7c-9e57-4791-9adf-ed7c3c4f6d20","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"863daf54-954c-4ed4-8a13-263f0340c1c7","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":"680a6604-9686-42f7-9030-36c0803deafa"},{"name":"Delete Workflow","id":"1e8a43ab-5f7b-4894-9aa9-9082f2ee3c52","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":"b8750884-3a68-4534-a427-8bd431bfc396","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"12c10a44-b3fa-4865-8e98-deadc8ea4678","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":"1e8a43ab-5f7b-4894-9aa9-9082f2ee3c52"},{"name":"Add Workflow Filter","id":"2bdb3a78-9b67-4f5e-9c2f-cf0cb3631a99","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":"861ae7a1-bfb3-44ef-b7f9-6662470cc8ec","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"686608ab-5c40-40bd-80cb-5bbe3dd9716a","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":"2bdb3a78-9b67-4f5e-9c2f-cf0cb3631a99"},{"name":"Delete Workflow Filter","id":"56d8d9f8-e35d-48c2-88c4-3eec76068886","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":"a67a29c2-c731-490e-a12a-e19b89578f11","type":"any","value":"","key":"workflowId"},{"id":"e774b5fc-d0f5-4338-8df1-92770a4bca58","type":"any","value":"","key":"filterId"}]}},"response":[{"id":"348d63ab-d9f8-4c9d-835c-4a55db0ae34e","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":"56d8d9f8-e35d-48c2-88c4-3eec76068886"},{"name":"Add Action","id":"75031ce1-4af9-4709-8a91-b1135d1f26b2","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":"61a53c7a-9a2e-47b0-9960-a747684dad87","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"2b419fcb-e865-43c6-9929-c9f1c6282562","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":"75031ce1-4af9-4709-8a91-b1135d1f26b2"},{"name":"Update Action","id":"20fb020e-1a83-42f3-8000-8bcfca482a25","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":"b5922d9d-034b-4db2-8dfc-191485e32e6b","type":"any","value":"","key":"workflowId"},{"id":"3f5bb4e2-e2bc-45b7-b955-c13bc479a6cb","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"0645509d-d560-498e-abc7-f008a8d5cfe9","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":"20fb020e-1a83-42f3-8000-8bcfca482a25"},{"name":"Delete Action","id":"dab63803-09bf-4cba-9e34-3fdde2c6280f","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":"ea560128-1f26-4869-86b0-0acaea9a21a9","type":"any","value":"","key":"workflowId"},{"id":"7deefc34-ff97-4213-9149-da03e56aef75","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"baab0858-ed84-4adc-9003-dccf06055c50","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":"dab63803-09bf-4cba-9e34-3fdde2c6280f"},{"name":"Add Action Filter","id":"71c2bfa9-b07a-402c-bd85-6d3f85104722","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":"8677d469-9cbd-42f2-a7bb-f04fd25d6d98","type":"any","value":"","key":"workflowId"},{"id":"2318f09f-7f8f-4a08-a21d-9c6c858af796","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"8dc974fd-7b25-4710-b9d2-5766a275131a","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":"71c2bfa9-b07a-402c-bd85-6d3f85104722"},{"name":"Delete Action Filter","id":"8c841fee-0d5f-4682-95fe-e17dc1461836","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":"41f5b6d1-a1d0-4b0a-8158-ab5af33bc7f6","type":"any","value":"","key":"workflowId"},{"id":"a55815f3-8f33-4cdc-bc26-a60770e311cc","type":"any","value":"","key":"actionId"},{"id":"b9649940-8f1b-420f-a558-a895b245e3fd","type":"any","value":"","key":"filterId"}]}},"response":[{"id":"464be466-007f-430f-a520-ca05c175bb9f","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":"8c841fee-0d5f-4682-95fe-e17dc1461836"},{"name":"Get Workflow Metadata","id":"122ab18b-c8f2-4ad1-9a99-e1e0a4ada680","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":"d3311ee9-0a01-40f3-9fb8-75b75a8c8525","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":"122ab18b-c8f2-4ad1-9a99-e1e0a4ada680"},{"name":"Execution Logs","id":"b72420fc-e614-4bf0-88db-31b3d8d53967","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":"6be7e35b-27c8-49e7-89f8-b098eabd562c","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":"b72420fc-e614-4bf0-88db-31b3d8d53967"},{"name":"Get Action Secret","id":"b4005226-b189-4922-83a2-4b3ec6b8b9d4","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":"bb384c7c-36cd-4c0d-b4a3-f533cbbb8656","type":"any","value":"","key":"workflowId"},{"id":"7b851526-12e3-4536-8c78-b6f87bd51a58","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"6aaa3b6d-e497-4b1f-9cf1-33eaef74425e","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":"b4005226-b189-4922-83a2-4b3ec6b8b9d4"},{"name":"Replay Workflow","id":"e094e5a3-1792-4c32-8824-e22d35df8cbc","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":"b1563ca9-0ce1-4ab6-81e4-539f35aa6f0c","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":"e094e5a3-1792-4c32-8824-e22d35df8cbc"}],"id":"a8ba09f2-7ad6-4e60-bfd8-00be020f6fdc","description":"

Workflows API

\n","_postman_id":"a8ba09f2-7ad6-4e60-bfd8-00be020f6fdc"},{"name":"SCIM","item":[{"name":"Get Users","id":"42863263-db2d-4efc-90c8-1cb0eabf8de1","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":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","id":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","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":"8a7ce15e-a3bb-4ff7-a0dd-7ecaf22dd254","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":"42863263-db2d-4efc-90c8-1cb0eabf8de1"},{"name":"Create User","id":"4ca2217e-cd2b-4f0a-bd5b-0674e87c5016","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":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","id":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"73c6d14c-185e-45c7-ae38-3532d6edd279","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":"4ca2217e-cd2b-4f0a-bd5b-0674e87c5016"},{"name":"Update User","id":"3a6096fc-2606-49a6-b8b2-474d1f3441e1","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":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","id":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users","user@yourcompany.com"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"26a614f7-c93e-43eb-919d-fd62037829bc","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":"3a6096fc-2606-49a6-b8b2-474d1f3441e1"},{"name":"Deactivate User","id":"39406ddd-2ea5-4d86-a062-b4bd87411321","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":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","id":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users","user@yourcompany.com"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"542f0ebb-94d0-407d-b778-bac0d581873b","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":"39406ddd-2ea5-4d86-a062-b4bd87411321"}],"id":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b7f51ab8-5d5c-4980-b569-93cf8f091431"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"83c72601-7631-4382-9d5e-aad216e9b7b5"}}],"_postman_id":"1ccde5b8-96f9-44ec-9ffc-787b2156b3e2","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","requests":{},"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":"51cc0935-6406-4dd2-bdb2-df927117a3f0"}},{"listen":"test","script":{"type":"text/javascript","requests":{},"exec":[""],"id":"59ca9cbf-36ea-4f53-8c4f-f2349d3b4d16"}}],"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":""}]}