Create a reminder category
curl --request POST \
--url https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "reminder-categories",
"attributes": {
"name": "<string>",
"default_lead_days": [
365
],
"default_recipient_team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"mandatory": true
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories"
payload = { "data": {
"type": "reminder-categories",
"attributes": {
"name": "<string>",
"default_lead_days": [365],
"default_recipient_team_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"mandatory": True
}
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'reminder-categories',
attributes: {
name: '<string>',
default_lead_days: [365],
default_recipient_team_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
mandatory: true
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories', 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.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories",
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([
'data' => [
'type' => 'reminder-categories',
'attributes' => [
'name' => '<string>',
'default_lead_days' => [
365
],
'default_recipient_team_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'mandatory' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <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.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"reminder-categories\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"default_lead_days\": [\n 365\n ],\n \"default_recipient_team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"mandatory\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+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.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"reminder-categories\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"default_lead_days\": [\n 365\n ],\n \"default_recipient_team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"mandatory\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"reminder-categories\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"default_lead_days\": [\n 365\n ],\n \"default_recipient_team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"mandatory\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "reminder-categories",
"attributes": {
"name": "Insurance",
"mandatory": true,
"default_lead_days": [
30,
7
],
"default_recipient_team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"archived_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
}
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"jsonapi": {
"version": "1.0"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"errors": [
{
"id": "d26cc34a-ceb2-45fb-aba2-c61782f9ec39",
"status": "422",
"title": "submitting organisation has no scheme share with the form's owning organisation",
"detail": "The request was understood but names something the server cannot act on.",
"code": "CH.001.054"
}
]
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Reminders
Create a reminder category
Create one of the organisation’s own categories of reminder, with the lead times and teams its reminders use unless they set their own. Every recipient team must be one of the organisation’s. A name already used by a live category is refused with 409 Conflict.
Requires reminder-categories:manage across the organisation.
POST
/
v3
/
orgs
/
{org_id}
/
reminder-categories
Create a reminder category
curl --request POST \
--url https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "reminder-categories",
"attributes": {
"name": "<string>",
"default_lead_days": [
365
],
"default_recipient_team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"mandatory": true
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories"
payload = { "data": {
"type": "reminder-categories",
"attributes": {
"name": "<string>",
"default_lead_days": [365],
"default_recipient_team_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"mandatory": True
}
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'reminder-categories',
attributes: {
name: '<string>',
default_lead_days: [365],
default_recipient_team_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
mandatory: true
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories', 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.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories",
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([
'data' => [
'type' => 'reminder-categories',
'attributes' => [
'name' => '<string>',
'default_lead_days' => [
365
],
'default_recipient_team_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'mandatory' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <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.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"reminder-categories\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"default_lead_days\": [\n 365\n ],\n \"default_recipient_team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"mandatory\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+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.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"reminder-categories\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"default_lead_days\": [\n 365\n ],\n \"default_recipient_team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"mandatory\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/orgs/{org_id}/reminder-categories")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"reminder-categories\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"default_lead_days\": [\n 365\n ],\n \"default_recipient_team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"mandatory\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "reminder-categories",
"attributes": {
"name": "Insurance",
"mandatory": true,
"default_lead_days": [
30,
7
],
"default_recipient_team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"archived_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
}
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"jsonapi": {
"version": "1.0"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"errors": [
{
"id": "d26cc34a-ceb2-45fb-aba2-c61782f9ec39",
"status": "422",
"title": "submitting organisation has no scheme share with the form's owning organisation",
"detail": "The request was understood but names something the server cannot act on.",
"code": "CH.001.054"
}
]
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Authorizations
SessionOAuth2Cookie
Body
application/vnd.api+json
The category to create in the organisation in the path.