Participation

Create or reuse a recipient participation follow-up

Requires the participation feature, programs_view and access to this organization-owned program. Requires participation_record, participation_submit or participation_configure, visible recipient history/placement and access to the supplied check. Requires an active recipient, participation settings and a participation rollup. Manually creates or reuses the open unresolved-enrollment task for this recipient and check period without waiting for configured thresholds. Uses the configured active assignee or the caller, with due date based on follow_up_due_days. Returns 201 for both a new task and reuse.

POST

admin

programs

{program_id}

participation

recipients

{entity_id}

follow-up

Create or reuse a recipient participation follow-up

curl --request POST \
  --url https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": 2
}
'

import requests

url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up"

payload = { "session_id": 2 }
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({session_id: 2})
};

fetch('https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up', 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/programs/{program_id}/participation/recipients/{entity_id}/follow-up",
  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([
    'session_id' => 2
  ]),
  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/programs/{program_id}/participation/recipients/{entity_id}/follow-up"

	payload := strings.NewReader("{\n  \"session_id\": 2\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/programs/{program_id}/participation/recipients/{entity_id}/follow-up")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"session_id\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up")

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  \"session_id\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "title": "<string>",
  "due_date": "2023-12-25",
  "assigned_to_user_id": 123
}

{
  "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"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

program_id

integer

required

Program whose participation setup, placements and checks are being accessed.

Required range: x >= 1

entity_id

integer

required

Recipient ID within this program.

Required range: x >= 1

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

session_id

integer

required

Validation: required|integer|min:1.

Required range: x >= 1

Response

Create or reuse a recipient participation follow-up response.

integer

required

title

string

required

due_date

string<date> | null

required

assigned_to_user_id

integer | null

required

Create or reuse a recipient participation follow-up

curl --request POST \
  --url https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": 2
}
'

import requests

url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up"

payload = { "session_id": 2 }
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({session_id: 2})
};

fetch('https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up', 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/programs/{program_id}/participation/recipients/{entity_id}/follow-up",
  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([
    'session_id' => 2
  ]),
  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/programs/{program_id}/participation/recipients/{entity_id}/follow-up"

	payload := strings.NewReader("{\n  \"session_id\": 2\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/programs/{program_id}/participation/recipients/{entity_id}/follow-up")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"session_id\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up")

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  \"session_id\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "title": "<string>",
  "due_date": "2023-12-25",
  "assigned_to_user_id": 123
}

{
  "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"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}