Update a form reminder
curl --request PUT \
--url https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id} \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "form-reminders",
"attributes": {
"name": "<string>",
"schedule": {
"interval": 26,
"weekdays": [],
"monthly": {
"day": 16
},
"starts_on": "2023-12-25",
"time_of_day": "07:30"
},
"grace_period_minutes": 5040,
"audience": {
"user_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"job_role_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
},
"relationships": {
"form": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "forms"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id}"
payload = { "data": {
"type": "form-reminders",
"attributes": {
"name": "<string>",
"schedule": {
"interval": 26,
"weekdays": [],
"monthly": { "day": 16 },
"starts_on": "2023-12-25",
"time_of_day": "07:30"
},
"grace_period_minutes": 5040,
"audience": {
"user_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"team_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"job_role_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
},
"relationships": { "form": { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "forms"
} } }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'form-reminders',
attributes: {
name: '<string>',
schedule: {
interval: 26,
weekdays: [],
monthly: {day: 16},
starts_on: '2023-12-25',
time_of_day: '07:30'
},
grace_period_minutes: 5040,
audience: {
user_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
team_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
job_role_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
}
},
relationships: {form: {data: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', type: 'forms'}}}
}
})
};
fetch('https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_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.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'form-reminders',
'attributes' => [
'name' => '<string>',
'schedule' => [
'interval' => 26,
'weekdays' => [
],
'monthly' => [
'day' => 16
],
'starts_on' => '2023-12-25',
'time_of_day' => '07:30'
],
'grace_period_minutes' => 5040,
'audience' => [
'user_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'team_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'job_role_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
],
'relationships' => [
'form' => [
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'forms'
]
]
]
]
]),
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}/form-reminders/{form_reminder_id}"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"form-reminders\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"schedule\": {\n \"interval\": 26,\n \"weekdays\": [],\n \"monthly\": {\n \"day\": 16\n },\n \"starts_on\": \"2023-12-25\",\n \"time_of_day\": \"07:30\"\n },\n \"grace_period_minutes\": 5040,\n \"audience\": {\n \"user_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"job_role_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n },\n \"relationships\": {\n \"form\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"forms\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id}")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"form-reminders\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"schedule\": {\n \"interval\": 26,\n \"weekdays\": [],\n \"monthly\": {\n \"day\": 16\n },\n \"starts_on\": \"2023-12-25\",\n \"time_of_day\": \"07:30\"\n },\n \"grace_period_minutes\": 5040,\n \"audience\": {\n \"user_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"job_role_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n },\n \"relationships\": {\n \"form\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"forms\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"form-reminders\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"schedule\": {\n \"interval\": 26,\n \"weekdays\": [],\n \"monthly\": {\n \"day\": 16\n },\n \"starts_on\": \"2023-12-25\",\n \"time_of_day\": \"07:30\"\n },\n \"grace_period_minutes\": 5040,\n \"audience\": {\n \"user_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"job_role_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n },\n \"relationships\": {\n \"form\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"forms\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "form-reminders",
"attributes": {
"name": "Morning check",
"schedule": {
"frequency": "weekly",
"interval": 26,
"weekdays": [
"mon"
],
"monthly": {
"mode": "day",
"day": 16,
"week": "first",
"weekday": "mon"
},
"starts_on": "2023-12-25",
"time_of_day": "07:30"
},
"grace_period_minutes": 5040,
"bank_holiday_nation": "england-and-wales",
"audience": {
"user_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"job_role_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"next_due_on": "2023-12-25"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
},
"form": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "forms"
}
}
},
"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": "7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f",
"status": "404",
"title": "Resource not found",
"detail": "The requested resource could not be found or does not exist.",
"code": "NOT_FOUND.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."
}Form Reminders
Update a form reminder
Replace a form reminder’s settings. Its form cannot change, and every user, team and job role in the audience must belong to the organisation.
Requires forms:create on the reminder’s form, held across the organisation or on that form.
PUT
/
v3
/
orgs
/
{org_id}
/
form-reminders
/
{form_reminder_id}
Update a form reminder
curl --request PUT \
--url https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id} \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "form-reminders",
"attributes": {
"name": "<string>",
"schedule": {
"interval": 26,
"weekdays": [],
"monthly": {
"day": 16
},
"starts_on": "2023-12-25",
"time_of_day": "07:30"
},
"grace_period_minutes": 5040,
"audience": {
"user_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"job_role_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
},
"relationships": {
"form": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "forms"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id}"
payload = { "data": {
"type": "form-reminders",
"attributes": {
"name": "<string>",
"schedule": {
"interval": 26,
"weekdays": [],
"monthly": { "day": 16 },
"starts_on": "2023-12-25",
"time_of_day": "07:30"
},
"grace_period_minutes": 5040,
"audience": {
"user_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"team_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"job_role_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
},
"relationships": { "form": { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "forms"
} } }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'form-reminders',
attributes: {
name: '<string>',
schedule: {
interval: 26,
weekdays: [],
monthly: {day: 16},
starts_on: '2023-12-25',
time_of_day: '07:30'
},
grace_period_minutes: 5040,
audience: {
user_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
team_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
job_role_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
}
},
relationships: {form: {data: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', type: 'forms'}}}
}
})
};
fetch('https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_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.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'form-reminders',
'attributes' => [
'name' => '<string>',
'schedule' => [
'interval' => 26,
'weekdays' => [
],
'monthly' => [
'day' => 16
],
'starts_on' => '2023-12-25',
'time_of_day' => '07:30'
],
'grace_period_minutes' => 5040,
'audience' => [
'user_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'team_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'job_role_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
],
'relationships' => [
'form' => [
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'forms'
]
]
]
]
]),
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}/form-reminders/{form_reminder_id}"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"form-reminders\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"schedule\": {\n \"interval\": 26,\n \"weekdays\": [],\n \"monthly\": {\n \"day\": 16\n },\n \"starts_on\": \"2023-12-25\",\n \"time_of_day\": \"07:30\"\n },\n \"grace_period_minutes\": 5040,\n \"audience\": {\n \"user_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"job_role_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n },\n \"relationships\": {\n \"form\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"forms\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id}")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"form-reminders\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"schedule\": {\n \"interval\": 26,\n \"weekdays\": [],\n \"monthly\": {\n \"day\": 16\n },\n \"starts_on\": \"2023-12-25\",\n \"time_of_day\": \"07:30\"\n },\n \"grace_period_minutes\": 5040,\n \"audience\": {\n \"user_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"job_role_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n },\n \"relationships\": {\n \"form\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"forms\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/orgs/{org_id}/form-reminders/{form_reminder_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"form-reminders\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"schedule\": {\n \"interval\": 26,\n \"weekdays\": [],\n \"monthly\": {\n \"day\": 16\n },\n \"starts_on\": \"2023-12-25\",\n \"time_of_day\": \"07:30\"\n },\n \"grace_period_minutes\": 5040,\n \"audience\": {\n \"user_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"team_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"job_role_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n },\n \"relationships\": {\n \"form\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"forms\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "form-reminders",
"attributes": {
"name": "Morning check",
"schedule": {
"frequency": "weekly",
"interval": 26,
"weekdays": [
"mon"
],
"monthly": {
"mode": "day",
"day": 16,
"week": "first",
"weekday": "mon"
},
"starts_on": "2023-12-25",
"time_of_day": "07:30"
},
"grace_period_minutes": 5040,
"bank_holiday_nation": "england-and-wales",
"audience": {
"user_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"job_role_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"next_due_on": "2023-12-25"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
},
"form": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "forms"
}
}
},
"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": "7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f",
"status": "404",
"title": "Resource not found",
"detail": "The requested resource could not be found or does not exist.",
"code": "NOT_FOUND.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
Path Parameters
Body
application/vnd.api+json
The reminder's new settings. relationships.form must name the form it already has.