Back to Developers
Getting Started Authentication Document Workflows Resources What's New in API v2

API version:

POST /public/v1/documents/:id/share
Share document. All old email recipients are removed.

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
401 Can't find document.
401 Can't find user.
401 No ACLs tying user to document.
422 shared_with contains invalid email address

Examples

POST /public/{version}/documents/3831ebf2-8540-4269-bcd1-3981fa908bea/share
{
  "access_token": "a6c7d01bd1c06f24d1d40b1c1946c36762852068ed03aeb0668a4431366e1f8e",
  "shared_with": [
    "one@e.mail",
    "two@e.mail"
  ],
  "document": {}
}
200
{
  "document": {
    "id": "3831ebf2-8540-4269-bcd1-3981fa908bea",
    "current_signer_id": "4825c9b4-8f01-4bca-b2e7-8d7158d35388",
    "name": "Test",
    "filename": "application.pdf",
    "executed_at": null,
    "expired_at": "2018-06-06T08:23:29.323-07:00",
    "sent_at": "2018-05-07T08:23:29.307-07:00",
    "state": "pending",
    "thumbnail_url": "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=j%2FKSG%2BHyxNiqJ5dJ3m9qSqDMvf8%3D",
    "sender": {
      "id": "433ec691-b661-4103-9721-e12a81f43ded",
      "name": "King Lind",
      "email": "alphonso@kihn.io",
      "signer": false
    },
    "recipients": [
      {
        "role_name": "signer2",
        "name": "Susie Orange",
        "email": "susie@citrix.com",
        "status": "pending",
        "id": "821e0abc-48d0-4ab5-9ea8-133a3dddfcf9",
        "sign_url": "https://secure.rs.dev:3000/signers/821e0abc-48d0-4ab5-9ea8-133a3dddfcf9/sign?access_token=yG2Pkkz3FvhuxKnPqNAf",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/821e0abc-48d0-4ab5-9ea8-133a3dddfcf9/reminders",
        "message": "Please sign.",
        "sequence": 1
      },
      {
        "role_name": "signer1",
        "name": "Joe Tangerine",
        "email": "joe@citrix.com",
        "status": "pending",
        "id": "4825c9b4-8f01-4bca-b2e7-8d7158d35388",
        "sign_url": "https://secure.rs.dev:3000/signers/4825c9b4-8f01-4bca-b2e7-8d7158d35388/sign?access_token=VySRyWxzdsrh5mA7p88A",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/4825c9b4-8f01-4bca-b2e7-8d7158d35388/reminders",
        "message": "Please sign.",
        "sequence": 0
      }
    ],
    "audits": [],
    "page_image_urls": [
      "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=MhjGt7MiHDHwzEG4AdZ2vJTzKhg%3D"
    ],
    "signed_pdf_url": null,
    "tags": {},
    "merge_field_values": [],
    "embed_codes": null,
    "in_person": false,
    "shared_with": [
      "one@e.mail",
      "two@e.mail"
    ],
    "identity_method": "email",
    "passcode_pin_enabled": false,
    "original_file_url": "https://rightsign-development.s3.amazonaws.com/base_files/original/59748f53-c244-4c05-8a42-a325e0570bf3/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=Xc6dIN5FsZAKVpCF8anl91Zt0cI%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf"
  }
}

Params

Param name Description
shared_with
required

List of email recipients to share the document with