Send several documents for signature at once
curl --request POST \
--url https://app.myhero.so/signature/batches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
{
"name": "<string>",
"email": "<string>",
"order": 2
}
],
"documents": [
{
"documentId": "<string>",
"blocks": [
{
"email": "<string>",
"nodeIds": [
"<string>"
]
}
],
"fields": [
{
"key": "<string>",
"recipientEmail": "<string>",
"required": true
}
]
}
],
"message": "<string>",
"name": "<string>"
}
'import requests
url = "https://app.myhero.so/signature/batches"
payload = {
"recipients": [
{
"name": "<string>",
"email": "<string>",
"order": 2
}
],
"documents": [
{
"documentId": "<string>",
"blocks": [
{
"email": "<string>",
"nodeIds": ["<string>"]
}
],
"fields": [
{
"key": "<string>",
"recipientEmail": "<string>",
"required": True
}
]
}
],
"message": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipients: [{name: '<string>', email: '<string>', order: 2}],
documents: [
{
documentId: '<string>',
blocks: [{email: '<string>', nodeIds: ['<string>']}],
fields: [{key: '<string>', recipientEmail: '<string>', required: true}]
}
],
message: '<string>',
name: '<string>'
})
};
fetch('https://app.myhero.so/signature/batches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.myhero.so/signature/batches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recipients' => [
[
'name' => '<string>',
'email' => '<string>',
'order' => 2
]
],
'documents' => [
[
'documentId' => '<string>',
'blocks' => [
[
'email' => '<string>',
'nodeIds' => [
'<string>'
]
]
],
'fields' => [
[
'key' => '<string>',
'recipientEmail' => '<string>',
'required' => true
]
]
]
],
'message' => '<string>',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.myhero.so/signature/batches"
payload := strings.NewReader("{\n \"recipients\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"order\": 2\n }\n ],\n \"documents\": [\n {\n \"documentId\": \"<string>\",\n \"blocks\": [\n {\n \"email\": \"<string>\",\n \"nodeIds\": [\n \"<string>\"\n ]\n }\n ],\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"required\": true\n }\n ]\n }\n ],\n \"message\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.myhero.so/signature/batches")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"order\": 2\n }\n ],\n \"documents\": [\n {\n \"documentId\": \"<string>\",\n \"blocks\": [\n {\n \"email\": \"<string>\",\n \"nodeIds\": [\n \"<string>\"\n ]\n }\n ],\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"required\": true\n }\n ]\n }\n ],\n \"message\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.myhero.so/signature/batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipients\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"order\": 2\n }\n ],\n \"documents\": [\n {\n \"documentId\": \"<string>\",\n \"blocks\": [\n {\n \"email\": \"<string>\",\n \"nodeIds\": [\n \"<string>\"\n ]\n }\n ],\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"required\": true\n }\n ]\n }\n ],\n \"message\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}Signatures
Send several documents for signature at once
Any number of documents, each its own request, grouped as one folder in each signer’s portal.
Each recipient gets one email and one link for all of theirs, and the signing order runs across the batch: a later recipient is emailed once everyone before them has signed every document.
If any document can’t be sent, none is.
POST
/
signature
/
batches
Send several documents for signature at once
curl --request POST \
--url https://app.myhero.so/signature/batches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
{
"name": "<string>",
"email": "<string>",
"order": 2
}
],
"documents": [
{
"documentId": "<string>",
"blocks": [
{
"email": "<string>",
"nodeIds": [
"<string>"
]
}
],
"fields": [
{
"key": "<string>",
"recipientEmail": "<string>",
"required": true
}
]
}
],
"message": "<string>",
"name": "<string>"
}
'import requests
url = "https://app.myhero.so/signature/batches"
payload = {
"recipients": [
{
"name": "<string>",
"email": "<string>",
"order": 2
}
],
"documents": [
{
"documentId": "<string>",
"blocks": [
{
"email": "<string>",
"nodeIds": ["<string>"]
}
],
"fields": [
{
"key": "<string>",
"recipientEmail": "<string>",
"required": True
}
]
}
],
"message": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipients: [{name: '<string>', email: '<string>', order: 2}],
documents: [
{
documentId: '<string>',
blocks: [{email: '<string>', nodeIds: ['<string>']}],
fields: [{key: '<string>', recipientEmail: '<string>', required: true}]
}
],
message: '<string>',
name: '<string>'
})
};
fetch('https://app.myhero.so/signature/batches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.myhero.so/signature/batches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recipients' => [
[
'name' => '<string>',
'email' => '<string>',
'order' => 2
]
],
'documents' => [
[
'documentId' => '<string>',
'blocks' => [
[
'email' => '<string>',
'nodeIds' => [
'<string>'
]
]
],
'fields' => [
[
'key' => '<string>',
'recipientEmail' => '<string>',
'required' => true
]
]
]
],
'message' => '<string>',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.myhero.so/signature/batches"
payload := strings.NewReader("{\n \"recipients\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"order\": 2\n }\n ],\n \"documents\": [\n {\n \"documentId\": \"<string>\",\n \"blocks\": [\n {\n \"email\": \"<string>\",\n \"nodeIds\": [\n \"<string>\"\n ]\n }\n ],\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"required\": true\n }\n ]\n }\n ],\n \"message\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.myhero.so/signature/batches")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"order\": 2\n }\n ],\n \"documents\": [\n {\n \"documentId\": \"<string>\",\n \"blocks\": [\n {\n \"email\": \"<string>\",\n \"nodeIds\": [\n \"<string>\"\n ]\n }\n ],\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"required\": true\n }\n ]\n }\n ],\n \"message\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.myhero.so/signature/batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipients\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"order\": 2\n }\n ],\n \"documents\": [\n {\n \"documentId\": \"<string>\",\n \"blocks\": [\n {\n \"email\": \"<string>\",\n \"nodeIds\": [\n \"<string>\"\n ]\n }\n ],\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"required\": true\n }\n ]\n }\n ],\n \"message\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}Authorizations
HERO personal access token
Body
application/json
Response
201 response
Show child attributes
Show child attributes