Start email sending
Begin the email sending template
The export_api value can be set separately to designate the format of the value to be received. (optional)
export_api is the feature that requests for a set value in esignon by a set URL when a customer approves or rejects in the process.
※ If the array-type parameter is optional, required values among the parameter values in the array must be entered during use. They do not need to be entered when it is not used.
※ The default value of the language parameter is "ko-KR" (Default settings)
API URL Info
Url | Type | Code |
https://docs.esignon.net/api/{CompID}/startsimple | POST | 5005Q |
Request
Parameters
PathParameters
Parameter Name | DataType | Description |
CompID | String | Company ID |
Headers
Parameter Name | DataType | Required | Description |
Content-Type | String | Required | "application/json" |
Authorization | String | Required | "esignon {token}" |
Body
Body - Header Parameter
Parameter Name | DataType | Required | Description |
request_code | String | Required | "5005Q" |
version | String | Required | "9.9.99" |
Body - Body Parameter
Parameter Name | DataType | Required | Description |
biz_id | String | Required | "0" |
workflow_name | String | Required | Title of the document to start |
doc_id | String | Required | templateID to start |
memb_email | String | Required | Email of document starter |
language | String | Optional | "ko-KR", "en-US", "ja-JP" |
comment | String | Optional | Delivered message |
player_list | Array | Required | The information of the signer be filled out according to the steps of the template step |
player_list.field_owner | String | Required | Start from "1" in the order of signing |
player_list.email | String | Required | |
player_list.name | String | Required | Name of the signer |
player_list.password_hint | String | Optional | Password hint |
player_list.password | String | Optional | Password |
field_list | Array | Optional | If there are values to be entered in advance, only the values of RadioBox, CheckBox, LabelBox and TextBox may be entered in advance |
field_list.field_name | String | Optional | Templete Field Name |
field_list.field_value | String | Optional | For the form field values of Radio and Check Box, the values are received as (“N” or ”Y”); for Label and Text Box, the text values are received as they are |
export_api_info | Array | Optional | The value set when exporting the written data |
export_api_info.api_type | String | Required | "StartAndEnd" (only start and end) or "ALL" (all) |
export_api_info.url | String | Required | URL to receive data from |
export_api_info.request_code | String | Required | The arbitrary value defined by the customer |
export_api_info.clientid | String | Optional | ID issued by esignon (question for issue) |
export_api_info.authorization | String | Optional | The value you want to set to header authorization when receiving data |
export_api_info.request_params | Array | Optional | Use when you want to get a specific value inside a document. |
export_api_info.request_params.param_id | String | Required | Name of the parameter to be received (user-specified) |
export_api_info.request_params.param_value | String | Required | Default value to be received in case the value to be received from Params.fields does not exist in the document |
export_api_info.request_params.fields | Array | Required | The value entered instead of param_value if the value corresponding to the field name exists in the document by querying the field name inside the template. |
export_api_info.request_params.fields.doc_id | String | Required | templateID |
export_api_info.request_params.fields.field_name | String | Required | template field name |
customer_list | Array | Optional | Add if there are additional referers |
customer_list.email | String | Required | Email address |
customer_list.name | String | Required | Referer Name |
customer_list.language | String | Optional | ko-KR, en-US, ja-JP |
Request Body Example
Request Body Example - only Required
Request Body Example - For TEST Account
Response
Code | Description | Reference |
200 | success | |
400 | Connection failed |
Result_msg
Code | Description | Reference |
00 | success | success |
10 | fail | fail |
99 | fail | Unexpected exception (incorrect format) |
12 | fail | Parsing failed because the body information of the received message is incorrect. |
Response Body Example
Response export_api Example
Last updated