Send a participant signature request
Uses Dropbox Sign for the organization-owned trip; provider actions exclude sample trips. Minor signers may require guardian contact details. Setup failures return 409 and temporary provider failures return 503. Creating a template draft adds it to this trip; deleting a template removes it from required templates across organization trips.
curl --request POST \
--url https://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_name": "<string>",
"subject": "<string>",
"message": "Please review the updated trip details.",
"require_guardian_signature": false,
"force_new": false,
"template_id": "<string>"
}
'import requests
url = "https://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures"
payload = {
"document_name": "<string>",
"subject": "<string>",
"message": "Please review the updated trip details.",
"require_guardian_signature": False,
"force_new": False,
"template_id": "<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({
document_name: '<string>',
subject: '<string>',
message: 'Please review the updated trip details.',
require_guardian_signature: false,
force_new: false,
template_id: '<string>'
})
};
fetch('https://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures', 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://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures",
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([
'document_name' => '<string>',
'subject' => '<string>',
'message' => 'Please review the updated trip details.',
'require_guardian_signature' => false,
'force_new' => false,
'template_id' => '<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://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures"
payload := strings.NewReader("{\n \"document_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"message\": \"Please review the updated trip details.\",\n \"require_guardian_signature\": false,\n \"force_new\": false,\n \"template_id\": \"<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://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"message\": \"Please review the updated trip details.\",\n \"require_guardian_signature\": false,\n \"force_new\": false,\n \"template_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures")
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 \"document_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"message\": \"Please review the updated trip details.\",\n \"require_guardian_signature\": false,\n \"force_new\": false,\n \"template_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"esignature_request_id": 123,
"trip_id": 123,
"trip_participant_id": 123,
"provider": "<string>",
"provider_request_id": "<string>",
"template_id": "<string>",
"document_name": "<string>",
"status": "<string>",
"signature_request_url": "<string>",
"signed_document_url": "<string>",
"signed_document_upload_id": 123,
"sent_at": "2023-11-07T05:31:56Z",
"signed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"existing": true,
"readiness": {
"required_templates": [
"<string>"
],
"signed_templates": [
"<string>"
],
"missing_templates": [
"<string>"
],
"is_ready": true
}
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Not Found",
"status": "error"
}{
"message": "<string>",
"reason_code": "<string>"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}{
"message": "<string>",
"reason_code": "<string>"
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Trip ID belonging to the authenticated organization.
Record ID within the organization and any parent resource in this route.
Body
Request fields accepted by this operation. Omitted optional properties retain the behavior described above.
Validation: nullable|string|max:255.
255Validation: nullable|string|max:255.
255Validation: nullable|string|max:2000.
2000"Please review the updated trip details."
Validation: nullable|boolean.
false
Validation: nullable|boolean.
false
Explicit template ID or first required_esign_templates entry from trip settings. One must be available.
255Response
Send a participant signature request response.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_name": "<string>",
"subject": "<string>",
"message": "Please review the updated trip details.",
"require_guardian_signature": false,
"force_new": false,
"template_id": "<string>"
}
'import requests
url = "https://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures"
payload = {
"document_name": "<string>",
"subject": "<string>",
"message": "Please review the updated trip details.",
"require_guardian_signature": False,
"force_new": False,
"template_id": "<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({
document_name: '<string>',
subject: '<string>',
message: 'Please review the updated trip details.',
require_guardian_signature: false,
force_new: false,
template_id: '<string>'
})
};
fetch('https://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures', 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://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures",
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([
'document_name' => '<string>',
'subject' => '<string>',
'message' => 'Please review the updated trip details.',
'require_guardian_signature' => false,
'force_new' => false,
'template_id' => '<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://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures"
payload := strings.NewReader("{\n \"document_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"message\": \"Please review the updated trip details.\",\n \"require_guardian_signature\": false,\n \"force_new\": false,\n \"template_id\": \"<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://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"message\": \"Please review the updated trip details.\",\n \"require_guardian_signature\": false,\n \"force_new\": false,\n \"template_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/trips/{tripId}/participants/{id}/esignatures")
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 \"document_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"message\": \"Please review the updated trip details.\",\n \"require_guardian_signature\": false,\n \"force_new\": false,\n \"template_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"esignature_request_id": 123,
"trip_id": 123,
"trip_participant_id": 123,
"provider": "<string>",
"provider_request_id": "<string>",
"template_id": "<string>",
"document_name": "<string>",
"status": "<string>",
"signature_request_url": "<string>",
"signed_document_url": "<string>",
"signed_document_upload_id": 123,
"sent_at": "2023-11-07T05:31:56Z",
"signed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"existing": true,
"readiness": {
"required_templates": [
"<string>"
],
"signed_templates": [
"<string>"
],
"missing_templates": [
"<string>"
],
"is_ready": true
}
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Not Found",
"status": "error"
}{
"message": "<string>",
"reason_code": "<string>"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}{
"message": "<string>",
"reason_code": "<string>"
}