Create a trip task
Creates a TripTask. If neither reminders nor reminder_days_before is sent, a default reminder schedule is generated from the trip’s task_reminder_days setting. Targeting is controlled via target_role, target_minors_only, target_guardians_only, and tag include/exclude lists. Requires manage_tasks.
curl --request POST \
--url https://api.gratona.com/v1/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id} \
--header 'Content-Type: application/json' \
--header 'session_id: <api-key>' \
--data '
{
"title": "<string>",
"document_path": "<string>",
"document_name": "<string>",
"description": "<string>",
"due_date": "2023-12-25",
"is_required": true,
"requires_document": true,
"requires_approval": true,
"depends_on_task_id": 123,
"depends_on_task_ids": [
123
],
"sort_order": 123,
"reminder_days_before": 123,
"reminders": [
{
"days_before": 123,
"send_at_date": "2023-12-25"
}
],
"target_minors_only": true,
"target_guardians_only": true,
"target_tags_include": [
"<string>"
],
"target_tags_exclude": [
"<string>"
]
}
'import requests
url = "https://api.gratona.com/v1/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}"
payload = {
"title": "<string>",
"document_path": "<string>",
"document_name": "<string>",
"description": "<string>",
"due_date": "2023-12-25",
"is_required": True,
"requires_document": True,
"requires_approval": True,
"depends_on_task_id": 123,
"depends_on_task_ids": [123],
"sort_order": 123,
"reminder_days_before": 123,
"reminders": [
{
"days_before": 123,
"send_at_date": "2023-12-25"
}
],
"target_minors_only": True,
"target_guardians_only": True,
"target_tags_include": ["<string>"],
"target_tags_exclude": ["<string>"]
}
headers = {
"session_id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {session_id: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
document_path: '<string>',
document_name: '<string>',
description: '<string>',
due_date: '2023-12-25',
is_required: true,
requires_document: true,
requires_approval: true,
depends_on_task_id: 123,
depends_on_task_ids: [123],
sort_order: 123,
reminder_days_before: 123,
reminders: [{days_before: 123, send_at_date: '2023-12-25'}],
target_minors_only: true,
target_guardians_only: true,
target_tags_include: ['<string>'],
target_tags_exclude: ['<string>']
})
};
fetch('https://api.gratona.com/v1/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}', 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/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}",
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([
'title' => '<string>',
'document_path' => '<string>',
'document_name' => '<string>',
'description' => '<string>',
'due_date' => '2023-12-25',
'is_required' => true,
'requires_document' => true,
'requires_approval' => true,
'depends_on_task_id' => 123,
'depends_on_task_ids' => [
123
],
'sort_order' => 123,
'reminder_days_before' => 123,
'reminders' => [
[
'days_before' => 123,
'send_at_date' => '2023-12-25'
]
],
'target_minors_only' => true,
'target_guardians_only' => true,
'target_tags_include' => [
'<string>'
],
'target_tags_exclude' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"session_id: <api-key>"
],
]);
$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/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"document_path\": \"<string>\",\n \"document_name\": \"<string>\",\n \"description\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"is_required\": true,\n \"requires_document\": true,\n \"requires_approval\": true,\n \"depends_on_task_id\": 123,\n \"depends_on_task_ids\": [\n 123\n ],\n \"sort_order\": 123,\n \"reminder_days_before\": 123,\n \"reminders\": [\n {\n \"days_before\": 123,\n \"send_at_date\": \"2023-12-25\"\n }\n ],\n \"target_minors_only\": true,\n \"target_guardians_only\": true,\n \"target_tags_include\": [\n \"<string>\"\n ],\n \"target_tags_exclude\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("session_id", "<api-key>")
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/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}")
.header("session_id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"document_path\": \"<string>\",\n \"document_name\": \"<string>\",\n \"description\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"is_required\": true,\n \"requires_document\": true,\n \"requires_approval\": true,\n \"depends_on_task_id\": 123,\n \"depends_on_task_ids\": [\n 123\n ],\n \"sort_order\": 123,\n \"reminder_days_before\": 123,\n \"reminders\": [\n {\n \"days_before\": 123,\n \"send_at_date\": \"2023-12-25\"\n }\n ],\n \"target_minors_only\": true,\n \"target_guardians_only\": true,\n \"target_tags_include\": [\n \"<string>\"\n ],\n \"target_tags_exclude\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["session_id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"document_path\": \"<string>\",\n \"document_name\": \"<string>\",\n \"description\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"is_required\": true,\n \"requires_document\": true,\n \"requires_approval\": true,\n \"depends_on_task_id\": 123,\n \"depends_on_task_ids\": [\n 123\n ],\n \"sort_order\": 123,\n \"reminder_days_before\": 123,\n \"reminders\": [\n {\n \"days_before\": 123,\n \"send_at_date\": \"2023-12-25\"\n }\n ],\n \"target_minors_only\": true,\n \"target_guardians_only\": true,\n \"target_tags_include\": [\n \"<string>\"\n ],\n \"target_tags_exclude\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
Legacy session-id header retained for backwards compatibility with older first-party clients. New integrations should prefer bearerAuth or apiKeyAuth.
Path Parameters
Body
required|string|max:255.
nullable|in:standard,acknowledgement. Defaults to standard.
standard, acknowledgement nullable|string|max:255.
nullable|string|max:255.
nullable|string|max:5000.
nullable|date.
nullable|integer|exists:trip_tasks,id scoped to this trip.
nullable|array of integers — alternative multi-dependency form.
nullable|in:and,or. Defaults to and.
and, or nullable|integer|min:0. Defaults to max+1.
nullable|integer|min:-365|max:365. Legacy single-reminder shortcut.
Show child attributes
Show child attributes
nullable|in:all,participant,leader. Defaults to all.
all, participant, leader 100100curl --request POST \
--url https://api.gratona.com/v1/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id} \
--header 'Content-Type: application/json' \
--header 'session_id: <api-key>' \
--data '
{
"title": "<string>",
"document_path": "<string>",
"document_name": "<string>",
"description": "<string>",
"due_date": "2023-12-25",
"is_required": true,
"requires_document": true,
"requires_approval": true,
"depends_on_task_id": 123,
"depends_on_task_ids": [
123
],
"sort_order": 123,
"reminder_days_before": 123,
"reminders": [
{
"days_before": 123,
"send_at_date": "2023-12-25"
}
],
"target_minors_only": true,
"target_guardians_only": true,
"target_tags_include": [
"<string>"
],
"target_tags_exclude": [
"<string>"
]
}
'import requests
url = "https://api.gratona.com/v1/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}"
payload = {
"title": "<string>",
"document_path": "<string>",
"document_name": "<string>",
"description": "<string>",
"due_date": "2023-12-25",
"is_required": True,
"requires_document": True,
"requires_approval": True,
"depends_on_task_id": 123,
"depends_on_task_ids": [123],
"sort_order": 123,
"reminder_days_before": 123,
"reminders": [
{
"days_before": 123,
"send_at_date": "2023-12-25"
}
],
"target_minors_only": True,
"target_guardians_only": True,
"target_tags_include": ["<string>"],
"target_tags_exclude": ["<string>"]
}
headers = {
"session_id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {session_id: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
document_path: '<string>',
document_name: '<string>',
description: '<string>',
due_date: '2023-12-25',
is_required: true,
requires_document: true,
requires_approval: true,
depends_on_task_id: 123,
depends_on_task_ids: [123],
sort_order: 123,
reminder_days_before: 123,
reminders: [{days_before: 123, send_at_date: '2023-12-25'}],
target_minors_only: true,
target_guardians_only: true,
target_tags_include: ['<string>'],
target_tags_exclude: ['<string>']
})
};
fetch('https://api.gratona.com/v1/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}', 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/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}",
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([
'title' => '<string>',
'document_path' => '<string>',
'document_name' => '<string>',
'description' => '<string>',
'due_date' => '2023-12-25',
'is_required' => true,
'requires_document' => true,
'requires_approval' => true,
'depends_on_task_id' => 123,
'depends_on_task_ids' => [
123
],
'sort_order' => 123,
'reminder_days_before' => 123,
'reminders' => [
[
'days_before' => 123,
'send_at_date' => '2023-12-25'
]
],
'target_minors_only' => true,
'target_guardians_only' => true,
'target_tags_include' => [
'<string>'
],
'target_tags_exclude' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"session_id: <api-key>"
],
]);
$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/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"document_path\": \"<string>\",\n \"document_name\": \"<string>\",\n \"description\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"is_required\": true,\n \"requires_document\": true,\n \"requires_approval\": true,\n \"depends_on_task_id\": 123,\n \"depends_on_task_ids\": [\n 123\n ],\n \"sort_order\": 123,\n \"reminder_days_before\": 123,\n \"reminders\": [\n {\n \"days_before\": 123,\n \"send_at_date\": \"2023-12-25\"\n }\n ],\n \"target_minors_only\": true,\n \"target_guardians_only\": true,\n \"target_tags_include\": [\n \"<string>\"\n ],\n \"target_tags_exclude\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("session_id", "<api-key>")
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/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}")
.header("session_id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"document_path\": \"<string>\",\n \"document_name\": \"<string>\",\n \"description\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"is_required\": true,\n \"requires_document\": true,\n \"requires_approval\": true,\n \"depends_on_task_id\": 123,\n \"depends_on_task_ids\": [\n 123\n ],\n \"sort_order\": 123,\n \"reminder_days_before\": 123,\n \"reminders\": [\n {\n \"days_before\": 123,\n \"send_at_date\": \"2023-12-25\"\n }\n ],\n \"target_minors_only\": true,\n \"target_guardians_only\": true,\n \"target_tags_include\": [\n \"<string>\"\n ],\n \"target_tags_exclude\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["session_id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"document_path\": \"<string>\",\n \"document_name\": \"<string>\",\n \"description\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"is_required\": true,\n \"requires_document\": true,\n \"requires_approval\": true,\n \"depends_on_task_id\": 123,\n \"depends_on_task_ids\": [\n 123\n ],\n \"sort_order\": 123,\n \"reminder_days_before\": 123,\n \"reminders\": [\n {\n \"days_before\": 123,\n \"send_at_date\": \"2023-12-25\"\n }\n ],\n \"target_minors_only\": true,\n \"target_guardians_only\": true,\n \"target_tags_include\": [\n \"<string>\"\n ],\n \"target_tags_exclude\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}