Share a file restore email

Sends a downloadable link to the specified email recipient to access restored files shared by email. Restored files are initially sent by email using POST /restores/files. After you send the initial email to one user, you can run this endpoint to share the email with additional users or to resend the email to the initial user. Also send the passcode generated from POST /restores/files to these users so they can access the restored files.

Path Parameters

• restored_file_id string required

  Performs the operation on the restored files with the specified ID. Use GET/restores/files to fetch the id value.

application/json

Request Body

• email_address string

  The email address of the user who will receive the download link to the restored file.

• message string

  The optional message sent as part of the email.

Responses

• 200
• default

---

Success

application/api.clumio.restored-files=v1+json

• Schema
• Example (from schema)

---

Schema

• _links object

  URLs to pages related to the resource.

  _self object

  The HATEOAS link to this resource.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  }
}

Error

application/json

• Schema
• Example (from schema)

---

Schema

• errors object[]

  A list of errors encountered during runtime.

  error_code uint32

  error_message string

  The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

POST /restores/files/:restored_file_id/_share    

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

restored_file_id — path required

Body

{
  "email_address": "string",
  "message": "string"
}

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files/:restored_file_id/_share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email_address": "string",
  "message": "string"
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files/:restored_file_id/_share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email_address": "string",
  "message": "string"
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files/:restored_file_id/_share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email_address": "string",
  "message": "string"
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files/:restored_file_id/_share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email_address": "string",
  "message": "string"
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files/:restored_file_id/_share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email_address": "string",
  "message": "string"
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files/:restored_file_id/_share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email_address": "string",
  "message": "string"
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files/:restored_file_id/_share' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email_address": "string",
  "message": "string"
}'