/procedures
POST {{base-api-url}}/procedures
Here are the details of the configuration:
interval: 5means that the reminder will be sent every 5 days. This param is optional.limit": 3means that the reminder will be executed 3 times, after that, he will be desactivated. This param is optional.configis the same structure than the config field in a procedure object. Except that you can have only anemailnode with only thereminder.executedevent.
Request Body
{"name"=>"Reminders", "description"=>"Description of my first procedure with reminders", "start"=>true, "members"=>[{"firstname"=>"John", "lastname"=>"Doe", "email"=>"john.doe@yousign.fr", "phone"=>"+33612345678", "fileObjects"=>[{"position"=>"191,497,507,603", "page"=>2, "file"=>"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}]}], "config"=>{"email"=>{"member.started"=>[{"subject"=>"Hey! You are invited to sign!", "message"=>"Hello <tag data-tag-type=\"string\" data-tag-name=\"recipient.firstname\"></tag> <tag data-tag-type=\"string\" data-tag-name=\"recipient.lastname\"></tag>, <br><br> You have ben invited to sign a document, please click on the following button to read it: <tag data-tag-type=\"button\" data-tag-name=\"url\" data-tag-title=\"Access to documents\">Access to documents</tag>", "to"=>["@member"]}]}, "reminders"=>[{"interval"=>5, "limit"=>3, "config"=>{"email"=>{"reminder.executed"=>[{"subject"=>"[URGENT] Hey, you have to sign this documents !", "message"=>"Hello <tag data-tag-type=\"string\" data-tag-name=\"recipient.firstname\"></tag> <tag data-tag-type=\"string\" data-tag-name=\"recipient.lastname\"></tag>, <br><br> This is a reminder. You have not yet signed your document. Please access it directly with the button: <tag data-tag-type=\"button\" data-tag-name=\"url\" data-tag-title=\"Access to documents\">Access to documents</tag>", "to"=>["@members.auto"]}]}}}]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | This value is a secret and needs to be replaced by your API Key (Bearer). | |
Content-Type | string | This header specifies the format of the exchanges in JSON. |
RESPONSES
status: Created
{"id":"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"Reminders","description":"Description of my first procedure with reminders","createdAt":"2018-12-05T06:16:56+01:00","updatedAt":"2018-12-05T06:16:56+01:00","finishedAt":null,"expiresAt":null,"status":"active","creator":null,"creatorFirstName":null,"creatorLastName":null,"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","template":false,"ordered":false,"parent":null,"metadata":[],"config":{"email":{"member.started":[{"subject":"Hey! You are invited to sign!","message":"Hello \u003ctag data-tag-type=\"string\" data-tag-name=\"recipient.firstname\"\u003e\u003c/tag\u003e \u003ctag data-tag-type=\"string\" data-tag-name=\"recipient.lastname\"\u003e\u003c/tag\u003e, \u003cbr\u003e\u003cbr\u003e You have ben invited to sign a document, please click on the following button to read it: \u003ctag data-tag-type=\"button\" data-tag-name=\"url\" data-tag-title=\"Access to documents\"\u003eAccess to documents\u003c/tag\u003e","to":["@member"]}]},"reminders":[{"interval":5,"limit":3,"config":{"email":{"reminder.executed":[{"subject":"[URGENT] Hey, you have to sign this documents !","message":"Hello \u003ctag data-tag-type=\"string\" data-tag-name=\"recipient.firstname\"\u003e\u003c/tag\u003e \u003ctag data-tag-type=\"string\" data-tag-name=\"recipient.lastname\"\u003e\u003c/tag\u003e, \u003cbr\u003e\u003cbr\u003e This is a reminder. You have not yet signed your document. Please access it directly with the button: \u003ctag data-tag-type=\"button\" data-tag-name=\"url\" data-tag-title=\"Access to documents\"\u003eAccess to documents\u003c/tag\u003e","to":["@members.auto"]}]}}}]},"members":[{"id":"/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","user":null,"type":"signer","firstname":"John","lastname":"Doe","email":"john.doe@yousign.fr","phone":"+33612345678","position":1,"createdAt":"2018-12-05T06:16:56+01:00","updatedAt":"2018-12-05T06:16:56+01:00","finishedAt":null,"status":"pending","fileObjects":[{"id":"/file_objects/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","file":{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"The best name for my file.pdf","type":"signable","contentType":"application/pdf","description":null,"createdAt":"2018-12-05T06:15:32+01:00","updatedAt":"2018-12-05T06:16:56+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null},"page":2,"position":"191,497,507,603","fieldName":null,"mention":null,"mention2":null,"createdAt":"2018-12-05T06:16:56+01:00","updatedAt":"2018-12-05T06:16:56+01:00","parent":null,"reason":"Signed by Yousign"}],"comment":null,"notificationsEmail":[],"operationLevel":"custom","operationCustomModes":["sms"],"operationModeSmsConfig":null,"parent":null}],"subscribers":[],"files":[{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"The best name for my file.pdf","type":"signable","contentType":"application/pdf","description":null,"createdAt":"2018-12-05T06:15:32+01:00","updatedAt":"2018-12-05T06:16:56+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null}],"relatedFilesEnable":false,"archive":false,"archiveMetadata":[],"fields":[],"permissions":[]}