Record recipient media consent evidence
Uses the current tenant and Library/linked-record permissions. Private preferences and collections belong to the current user. Mutations are unavailable in support sessions. Requires media_clearance_manage and recipient access. valid_from defaults to now; expires_at must be later. Evidence permits supporter/public media use according to its scope.
curl --request POST \
--url https://api.gratona.com/v1/admin/workspace-library/consent-evidence \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient_id": 2,
"signer_name": "<string>",
"signer_role": "<string>",
"valid_from": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"notes": "<string>"
}
'import requests
url = "https://api.gratona.com/v1/admin/workspace-library/consent-evidence"
payload = {
"recipient_id": 2,
"signer_name": "<string>",
"signer_role": "<string>",
"valid_from": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"notes": "<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({
recipient_id: 2,
signer_name: '<string>',
signer_role: '<string>',
valid_from: '2023-11-07T05:31:56Z',
expires_at: '2023-11-07T05:31:56Z',
notes: '<string>'
})
};
fetch('https://api.gratona.com/v1/admin/workspace-library/consent-evidence', 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/workspace-library/consent-evidence",
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([
'recipient_id' => 2,
'signer_name' => '<string>',
'signer_role' => '<string>',
'valid_from' => '2023-11-07T05:31:56Z',
'expires_at' => '2023-11-07T05:31:56Z',
'notes' => '<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/workspace-library/consent-evidence"
payload := strings.NewReader("{\n \"recipient_id\": 2,\n \"signer_name\": \"<string>\",\n \"signer_role\": \"<string>\",\n \"valid_from\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<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/workspace-library/consent-evidence")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipient_id\": 2,\n \"signer_name\": \"<string>\",\n \"signer_role\": \"<string>\",\n \"valid_from\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/workspace-library/consent-evidence")
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 \"recipient_id\": 2,\n \"signer_name\": \"<string>\",\n \"signer_role\": \"<string>\",\n \"valid_from\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"evidence_kind": "<string>",
"consent_scope": "<string>",
"subject_type": "<string>",
"subject_id": 123,
"signer_name": "<string>",
"signer_role": "<string>",
"valid_from": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"state": "<string>",
"story_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
Passport bearer token authentication for legacy admin sessions.
Body
Request fields accepted by this operation. Omitted optional properties retain the behavior described above.
Validation: required|integer|min:1.
x >= 1Validation: required|in:signed_release,event_notice,self_consent,policy.
signed_release, event_notice, self_consent, policy Validation: required|in:donor_safe,public_safe.
donor_safe, public_safe Validation: nullable|string|max:255.
255Validation: nullable|string|max:255.
255Validation: nullable|date.
Validation: nullable|date.
Validation: nullable|string|max:5000.
5000Response
Record recipient media consent evidence response.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.gratona.com/v1/admin/workspace-library/consent-evidence \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient_id": 2,
"signer_name": "<string>",
"signer_role": "<string>",
"valid_from": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"notes": "<string>"
}
'import requests
url = "https://api.gratona.com/v1/admin/workspace-library/consent-evidence"
payload = {
"recipient_id": 2,
"signer_name": "<string>",
"signer_role": "<string>",
"valid_from": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"notes": "<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({
recipient_id: 2,
signer_name: '<string>',
signer_role: '<string>',
valid_from: '2023-11-07T05:31:56Z',
expires_at: '2023-11-07T05:31:56Z',
notes: '<string>'
})
};
fetch('https://api.gratona.com/v1/admin/workspace-library/consent-evidence', 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/workspace-library/consent-evidence",
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([
'recipient_id' => 2,
'signer_name' => '<string>',
'signer_role' => '<string>',
'valid_from' => '2023-11-07T05:31:56Z',
'expires_at' => '2023-11-07T05:31:56Z',
'notes' => '<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/workspace-library/consent-evidence"
payload := strings.NewReader("{\n \"recipient_id\": 2,\n \"signer_name\": \"<string>\",\n \"signer_role\": \"<string>\",\n \"valid_from\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<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/workspace-library/consent-evidence")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipient_id\": 2,\n \"signer_name\": \"<string>\",\n \"signer_role\": \"<string>\",\n \"valid_from\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/workspace-library/consent-evidence")
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 \"recipient_id\": 2,\n \"signer_name\": \"<string>\",\n \"signer_role\": \"<string>\",\n \"valid_from\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"evidence_kind": "<string>",
"consent_scope": "<string>",
"subject_type": "<string>",
"subject_id": 123,
"signer_name": "<string>",
"signer_role": "<string>",
"valid_from": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"state": "<string>",
"story_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."
}