Agnostic Guides
...
Box Endpoints
Sign (available version > 6.6.5)
2 min
currently docuflow has an endpoint to create a request to sign documents and send them to multiple users to sign the file note if the document assigning sign request is in a specific folder under root specify the root folder id in box configuration tab request url https localhost 82 scrud createtask name sign documents method post request pathparameters queryparameters headerparameters bodydataparameters kind required name id type string description unique id of box file or folder kind required name type type string description name of metadata template in box kind required name selectedcms type string description value should always be set to box to let docuflow know which configured content system to search kind required name body type array description json array of strings each index being a seperate line n nor can take a single string value singlelineexample kind required name duedate type string description number of days from today the sign request is valid for example 5 n kind required name recipients type array description array of strings of recipients of the task email id n n user may require permissions to file before being able to be assigned a sign request kind optional name enablesamedestination type boolean description if true signed document and signing log is stored in the same location as source file destination id auto filledis generated by middleware n nif false signed document and signing log is stored in the destination location n kind required name destinationid type string description location where the signed document and signing log is stored only when enablesamedestination is false n kind required name tasktype type string children description task type of a sign request is sign formdataparameters results languages id qnynaqpohj1uw zegafj6 code language 200 id frmyak2f3gpeahrtkdavt code language 500 selectedlanguageid qnynaqpohj1uw zegafj6 examples languages id npeo0ussrolpgszc5fphh code r n cmsname demoprod r n id 917235734365 r n tasktype sign r n recipients r n bhavanis versafile com r n r n destinationid 156906751612 r n type purchaseorder r n selectedcms box r n duedate 1 r n enablesamedestination false r n language json id zhu ix53onpcu7rtssn1n code language none selectedlanguageid npeo0ussrolpgszc5fphh description create a sign request on a document currentnewparameter label body parameter value bodydataparameters tab examples url https localhost 82 scrud createtask name sign documents method post request pathparameters queryparameters headerparameters bodydataparameters kind required name id type string description unique id of box file or folder kind required name type type string description name of metadata template in box kind required name selectedcms type string description value should always be set to box to let docuflow know which configured content system to search kind required name body type array description json array of strings each index being a seperate line n nor can take a single string value singlelineexample kind required name duedate type string description number of days from today the sign request is valid for n kind required name recipients type array description array of strings of recipients of the task email id n n user may require permissions to file before being able to be assigned a sign request kind optional name enablesamedestination type boolean description if true signed document and signing log is stored in the same location as source file destination id auto filledis generated by middleware n nif false signed document and signing log is stored in the destination location n kind required name destinationid type string description location where the signed document and signing log is stored only when enablesamedestination is false n kind required name tasktype type string children description task type of a sign request is sign formdataparameters results languages id qnynaqpohj1uw zegafj6 code language 200 id frmyak2f3gpeahrtkdavt code language 500 selectedlanguageid qnynaqpohj1uw zegafj6 examples languages id npeo0ussrolpgszc5fphh code r n cmsname demoprod r n id 917235734365 r n tasktype sign r n recipients r n bhavanis versafile com r n r n destinationid 156906751612 r n type purchaseorder r n selectedcms box r n duedate 1 r n enablesamedestination false r n language json id zhu ix53onpcu7rtssn1n code language none selectedlanguageid npeo0ussrolpgszc5fphh description use case scenario store signed document and signing log where orginal document is n nwhen the enablesamedestination is set to true the signed document and signing log will be stored in the same location as source file i e; the parent folder of id n currentnewparameter label body parameter value bodydataparameters tab examples url https localhost 82 scrud createtask name sign documents method post request pathparameters queryparameters headerparameters bodydataparameters kind required name id type string description unique id of box file or folder kind required name type type string description name of metadata template in box kind required name selectedcms type string description value should always be set to box to let docuflow know which configured content system to search kind required name body type array description json array of strings each index being a seperate line n nor can take a single string value singlelineexample kind required name duedate type string description number of days from today the sign request is valid for n kind required name recipients type array description array of strings of recipients of the task email id n n user may require permissions to file before being able to be assigned a sign request kind optional name enablesamedestination type boolean description if true signed document and signing log is stored in the same location as source file destination id auto filledis generated by middleware n nif false signed document and signing log is stored in the destination location n kind required name destinationid type string description location where the signed document and signing log is stored only when enablesamedestination is false n kind required name tasktype type string children description task type of a sign request is sign formdataparameters results languages id qnynaqpohj1uw zegafj6 code language 200 id frmyak2f3gpeahrtkdavt code language 500 selectedlanguageid qnynaqpohj1uw zegafj6 examples languages id npeo0ussrolpgszc5fphh code r n cmsname demoprod r n id 917235734365 r n tasktype sign r n recipients r n bhavanis versafile com r n singetambhavani7 gmail com r n r n destinationid 156906751612 r n type purchaseorder r n selectedcms box r n duedate 1 r n enablesamedestination false r n language json id zhu ix53onpcu7rtssn1n code language none selectedlanguageid npeo0ussrolpgszc5fphh description use case scenario multiple sign recipients n nthe request can be sent to multiple signers if one signer declines the request the whole request will be cancelled n currentnewparameter label body parameter value bodydataparameters