/file_objects
POST {{base-api-url}}/file_objects
The default value of the reason is *Signed by Yousign*
but can therefore be overridden by the value of your choice.
This functionality is mainly implemented with the use of the Server stamp.
Request Body
{"file"=>"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "member"=>"/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "position"=>"230,499,464,589", "page"=>2, "mention"=>"Read and approved", "mention2"=>"Signed by John Doe", "reason"=>"Signed by John Doe (Yousign)"}
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":"/file_objects/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","file":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","page":2,"position":"230,499,464,589","fieldName":null,"mention":"Read and approved","mention2":"Signed by John Doe","createdAt":"2018-12-28T13:59:32+01:00","updatedAt":"2018-12-28T13:59:32+01:00","member":{"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-28T13:59:10+01:00","updatedAt":"2018-12-28T13:59:10+01:00","finishedAt":null,"status":"pending","comment":null,"parent":null,"contact":null,"fields":null},"parent":null,"reason":"Signed by John Doe (Yousign)"}