Sign in

v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Papersign Documents

This endpoint moves a document to a new location. Please note that this feature is exclusively available as part of the Papersign API.

post/papersign/documents/{id}/move

Path parameters

idstring required

The ID of the Papersign document.

Request body

namestring

The new name of the document.

space_idnumber

The unique identifier of the space to move the document to.

pathstring

The path to move the document to. Maximum depth is 4 levels. Any missing folders will be created.

folder_idnumber

The unique identifier of the folder to move the document to. Required when space_id and path are not present.

Example request

{
  "name": "My Copied Document",
  "space_id": 8888,
  "path": "/path/to/folder",
  "folder_id": 9999
}

Response

Successfully moved a document to a new location

status'ok'

Example response

{
  "results": {
    "document": {
      "id": "5d40fdaf174b4c0007043072",
      "name": "My Document",
      "status": "completed",
      "folder": {
        "id": 9999,
        "name": "My Document",
        "parent_id": 9999,
        "space_id": 8888
      },
      "space": {
        "id": 9999,
        "name": "My Space",
        "root_folder_id": 9999,
        "allow_team_access": true
      },
      "signers": [
        {
          "key": "akdj17",
          "name": "Jack Smith",
          "email": "signer@example.com",
          "phone": "123 456 7899",
          "job_title": "Account Manager",
          "company": "Explosive Startup",
          "custom_attributes": [
            {
              "key": "Relationship",
              "label": "Relationship to the company",
              "value": "CEO"
            }
          ]
        }
      ],
      "variables": [
        {
          "key": "adk123",
          "name": "Variable 1",
          "value": "value 1"
        }
      ],
      "created_at_utc": "2019-04-14T09:00:00.000Z",
      "updated_at_utc": "2019-04-14T09:00:00.000Z",
      "sent_at_utc": "2019-04-14T09:00:00.000Z",
      "completed_at_utc": "2019-04-14T09:00:00.000Z",
      "source": {
        "type": "paperform_submission",
        "paperform_form_id": "iwl6j5lh",
        "paperform_submission_id": "6a18dfcdcc9dc182fc0031cc"
      }
    }
  }
}