SendSafely REST API

https://rest-api-docs.sendsafely.com/
Admin
The SendSafely REST API provides programmatic access to SendSafely, enabling developers to integrate...
Tokens:2,442
Snippets:10
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Untitled

No description

--------------------------------

### Recipient Details Response (JSON)

Source: https://rest-api-docs.sendsafely.com/index

This is an example JSON response for a 'Get Recipient' API call, detailing various attributes of a recipient, such as their ID, email, phone numbers, and role within the package.

```json
{
  "approvalRequired": "<boolean>",
  "checkForPublicKeys": "<boolean>",
  "recipientId": "<string>",
  "email": "<string>",
  "phonenumbers": [
    {
      "countryCode": "<integer>",
      "phonenumber": "<integer>",
      "wasUsedMostRecently": "<boolean>"
    },
    {
      "countryCode": "<integer>",
      "phonenumber": "<integer>",
      "wasUsedMostRecently": "<boolean>"
    }
  ],
  "fullName": "<string>",
  "smsAuth": "<boolean>",
  "isPackageOwner": "<boolean>",
  "roleName": "<string>",
  "response": "<string>"
}
```

--------------------------------

### Get Recipient Details (cURL)

Source: https://rest-api-docs.sendsafely.com/index

This cURL command retrieves the details of a specific recipient associated with a SendSafely package. It requires the package ID and recipient ID, along with authentication headers.

```cURL
curl --location 'https://yourcompany.sendsafely.com/api/v2.0/package/<string>/recipient/<string>/' \
--header 'ss-api-key: <string>' \
--header 'ss-request-signature: <string>' \
--header 'ss-request-timestamp: <string>'
```

--------------------------------

### GET /package/{packageId}/recipient/{recipientId}/

Source: https://rest-api-docs.sendsafely.com/index

Retrieves the details for a specific recipient associated with a particular SendSafely package.

```APIDOC
## GET /package/{packageId}/recipient/{recipientId}/

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

### Method
GET

### Endpoint
https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The ID of the package.
- **recipientId** (string) - Required - The ID of the recipient.

#### Headers
- **ss-api-key** (string) - Required - Your SendSafely API key.
- **ss-request-signature** (string) - Required - The signature for the request.
- **ss-request-timestamp** (string) - Required - The timestamp for the request.

### Request Example
```curl
curl --location 'https://yourcompany.sendsafely.com/api/v2.0/package/<string>/recipient/<string>/' \
--header 'ss-api-key: <string>' \
--header 'ss-request-signature: <string>' \
--header 'ss-request-timestamp: <string>'
```

### Response
#### Success Response (200)
- **approvalRequired** (boolean) - Indicates if approval is required for the recipient.
- **checkForPublicKeys** (boolean) - Indicates if public key checks are performed.
- **recipientId** (string) - The unique identifier for the recipient.
- **email** (string) - The email address of the recipient.
- **phonenumbers** (array) - A list of phone numbers associated with the recipient.
  - **countryCode** (integer) - The country code for the phone number.
  - **phonenumber** (integer) - The phone number.
  - **wasUsedMostRecently** (boolean) - Indicates if this number was used most recently.
- **fullName** (string) - The full name of the recipient.
- **smsAuth** (boolean) - Indicates if SMS authentication is enabled for the recipient.
- **isPackageOwner** (boolean) - Indicates if the recipient is the owner of the package.
- **roleName** (string) - The role assigned to the recipient.
- **response** (string) - A response message from the API.

#### Response Example
```json
{
  "approvalRequired": "<boolean>",
  "checkForPublicKeys": "<boolean>",
  "recipientId": "<string>",
  "email": "<string>",
  "phonenumbers": [
    {
      "countryCode": "<integer>",
      "phonenumber": "<integer>",
      "wasUsedMostRecently": "<boolean>"
    },
    {
      "countryCode": "<integer>",
      "phonenumber": "<integer>",
      "wasUsedMostRecently": "<boolean>"
    }
  ],
  "fullName": "<string>",
  "smsAuth": "<boolean>",
  "isPackageOwner": "<boolean>",
  "roleName": "<string>",
  "response": "<string>"
}
```
```

--------------------------------

### Untitled

No description

--------------------------------

### Untitled

No description

--------------------------------

### POST /package/{packageId}/recipient/{recipientId}/

Source: https://rest-api-docs.sendsafely.com/index

Updates the details for a specific recipient on a SendSafely package.

```APIDOC
## POST /package/{packageId}/recipient/{recipientId}/

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

### Method
POST

### Endpoint
https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The ID of the package.
- **recipientId** (string) - Required - The ID of the recipient.

#### Headers
- **ss-api-key** (string) - Required - Your SendSafely API key.
- **ss-request-signature** (string) - Required - The signature for the request.
- **ss-request-timestamp** (string) - Required - The timestamp for the request.
- **Content-Type** (string) - Required - The content type of the request body, must be application/json.

#### Request Body
- **countrycode** (string) - Optional - The country code for the recipient's phone number.
- **phoneNumber** (string) - Optional - The phone number of the recipient.
- **roleName** (string) - Optional - The role name for the recipient.
- **workspaceNotificationPreference** (string) - Optional - The workspace notification preference for the recipient.

### Request Example
```curl
curl --location 'https://yourcompany.sendsafely.com/api/v2.0/package/<string>/recipient/<string>/' \
--header 'ss-api-key: <string>' \
--header 'ss-request-signature: <string>' \
--header 'ss-request-timestamp: <string>' \
--header 'Content-Type: application/json' \
--data '{"role": "<string>"}'
```

### Response
#### Success Response (200)
- **approvalRequired** (boolean) - Indicates if approval is required for the recipient.
- **checkForPublicKeys** (boolean) - Indicates if public key checks are performed.
- **recipientId** (string) - The unique identifier for the recipient.
- **email** (string) - The email address of the recipient.
- **phonenumbers** (array) - A list of phone numbers associated with the recipient.
  - **countryCode** (integer) - The country code for the phone number.
  - **phonenumber** (integer) - The phone number.
  - **wasUsedMostRecently** (boolean) - Indicates if this number was used most recently.
- **fullName** (string) - The full name of the recipient.
- **smsAuth** (boolean) - Indicates if SMS authentication is enabled for the recipient.
- **isPackageOwner** (boolean) - Indicates if the recipient is the owner of the package.
- **roleName** (string) - The role assigned to the recipient.
- **response** (string) - A response message from the API.

#### Response Example
```json
{
  "approvalRequired": "<boolean>",
  "checkForPublicKeys": "<boolean>",
  "recipientId": "<string>",
  "email": "<string>",
  "phonenumbers": [
    {
      "countryCode": "<integer>",
      "phonenumber": "<integer>",
      "wasUsedMostRecently": "<boolean>"
    },
    {
      "countryCode": "<integer>",
      "phonenumber": "<integer>",
      "wasUsedMostRecently": "<boolean>"
    }
  ],
  "fullName": "<string>",
  "smsAuth": "<boolean>",
  "isPackageOwner": "<boolean>",
  "roleName": "<string>",
  "response": "<string>"
}
```
```

--------------------------------

### Update Recipient Details (cURL)

Source: https://rest-api-docs.sendsafely.com/index

This cURL command demonstrates how to update the details of a specific recipient on a SendSafely package. It requires the package ID, recipient ID, authentication headers, and a JSON payload specifying the fields to update.

```cURL
curl --location 'https://yourcompany.sendsafely.com/api/v2.0/package/<string>/recipient/<string>/' \
--header 'ss-api-key: <string>' \
--header 'ss-request-signature: <string>' \
--header 'ss-request-timestamp: <string>' \
--header 'Content-Type: application/json' \
--data '{\"role\": \"<string>\"}'
```

--------------------------------

### Untitled

No description

--------------------------------

### Recipient Update Request Body (JSON)

Source: https://rest-api-docs.sendsafely.com/index

This JSON object represents the request body for updating a recipient's details. It allows specifying attributes like country code, phone number, role name, and workspace notification preference.

```json
{"countrycode": "<string>", "phoneNumber": "<string>", "roleName": "<string>", "workspaceNotificationPreference": "<string>"}
```
Tokens:
Raw