API version:
POST /public/v2/documents/:id/update_tags
Update the tags on a given document. All old tags are removed.
Supported Formats
jsonErrors
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 | Hash contains empty keys |
Examples
POST /public/{version}/documents/8e6f2e54-dd6e-4a7a-97bc-cf00ee042e5b/update_tags { "access_token": "f60307b600e8bd2dfaba3a106d54bfbbfd0782cf9d819e27bce9d2fd7cb65226", "tags": { "testing": "one", "single": null }, "document": { "tags": { "testing": "one", "single": null } } } 200 { "document": { "id": "8e6f2e54-dd6e-4a7a-97bc-cf00ee042e5b", "current_signer_id": "e33b0297-9896-4d29-8257-926ecc973da8", "name": "Test", "filename": "application.pdf", "executed_at": null, "expired_at": "2018-06-06T08:23:29.880-07:00", "sent_at": "2018-05-07T08:23:29.861-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=1525793010&Signature=ZzZMm4z8qO2nyp2CeIcwae6TJXY%3D", "sender": { "id": "a0068e99-8b25-4f43-ad2f-0fd4f06aac9d", "name": "Remington Lubowitz", "email": "lon@carroll.co", "signer": false }, "recipients": [ { "role_name": "signer2", "name": "Susie Orange", "email": "susie@citrix.com", "status": "pending", "id": "cb6f89ab-181f-485e-8d51-eadff36dbd71", "sign_url": "https://secure.rs.dev:3000/signers/cb6f89ab-181f-485e-8d51-eadff36dbd71/sign?access_token=xKTvz4bynLVoBHrNnLRx", "remind_url": "https://api.rs.dev:3002/public/{version}/signers/cb6f89ab-181f-485e-8d51-eadff36dbd71/reminders", "message": "Please sign.", "sequence": 1 }, { "role_name": "signer1", "name": "Joe Tangerine", "email": "joe@citrix.com", "status": "pending", "id": "e33b0297-9896-4d29-8257-926ecc973da8", "sign_url": "https://secure.rs.dev:3000/signers/e33b0297-9896-4d29-8257-926ecc973da8/sign?access_token=SBH7ZiLa3D4kZRahjTE6", "remind_url": "https://api.rs.dev:3002/public/{version}/signers/e33b0297-9896-4d29-8257-926ecc973da8/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=1525793010&Signature=xdXJz%2F7TzDSzGI3FmGnJ2FQHNQI%3D" ], "signed_pdf_url": null, "tags": { "testing": "one", "single": null }, "merge_field_values": [], "embed_codes": null, "in_person": false, "shared_with": [ "test@test.com" ], "identity_method": "email", "passcode_pin_enabled": false, "original_file_url": "https://rightsign-development.s3.amazonaws.com/base_files/original/5b73cc43-0f3f-4f2f-9b02-a617fa6b1f72/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=F5WeH34v5jPGbrtVEe96D%2F%2FPXMw%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf" } }
Params
Param name | Description |
---|---|
tags required |
Key value tags for categorization |