/procedures
POST {{base-api-url}}/procedures
Here is a procedure with the right way to add from value in the subject of the email.
Request Body
{"name"=>"Subject prefix - OK", "description"=>"This is the way you have to use to customize the prefix of the subject for the e-mails.", "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"=>"==> Here is the prefix! <== 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"]}]}}}
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":"Subject prefix - OK","description":"This is the way you have to use to customize the prefix of the subject for the e-mails.","createdAt":"2018-12-05T06:28:56+01:00","updatedAt":"2018-12-05T06:28: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":"==\u003e Here is the prefix! \u003c== 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"]}]}},"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:28:56+01:00","updatedAt":"2018-12-05T06:28: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:28:42+01:00","updatedAt":"2018-12-05T06:28: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:28:56+01:00","updatedAt":"2018-12-05T06:28: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:28:42+01:00","updatedAt":"2018-12-05T06:28: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":[]}