Safety
The safeguarding settings: who is told about a safety concern.
/v1/safety/settingsGet the safeguarding settings
The organization's country, time zone, safeguarding contacts (told at once about a safety concern) and privacy notice link.
Returns
200 The settings. data is SafeguardingSettings.
Fields of data
countrystring | nullrequiredISO 3166 country code: the emergency and help lines the avatars give, and the age a parent must consent under.
timeZonestring | nullrequiredIANA time zone for dates in safety emails (UTC when null).
safeguardingContactsstring[]requiredUp to 10 email addresses told at once about a safety flag, beside the owners and admins.
privacyNoticeUrlstring | nullrequiredYour privacy notice, linked where people start a conversation.
Errors
invalid_requestunauthorizedforbiddenupgrade_requiredrate_limitedserver_error
Request
curl "https://app.zentiqai.com/v1/safety/settings" \
-H "Authorization: Bearer $ZENTIQ_API_KEY"import { Zentiq } from "@zentiq/node";
const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.getSafeguardingSettings();import os
from zentiq import Zentiq
zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.get_safeguarding_settings()Response
{
"data": {
"country": "US",
"timeZone": "America/New_York",
"safeguardingContacts": [
"…"
],
"privacyNoticeUrl": "https://www.example.com"
},
"error": null,
"requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}/v1/safety/settingsChange the safeguarding settings
Changes the fields sent, checked as the console checks them (a country from the list, a real time zone, up to 10 email addresses, an https link). Each change is recorded in the organization's activity log as made by the key (the contacts' addresses never are, only how many there are).
Body
countrystring | nullA country code or name; null clears it.
timeZonestring | nullAn IANA time zone; null clears it.
safeguardingContactsstring[]The whole list (replaces it); [] removes every contact.
at most 10 items
privacyNoticeUrlstring | nullA web address starting with https://; null clears it.
Returns
200 The settings after the change. data is SafeguardingSettings.
Fields of data
countrystring | nullrequiredISO 3166 country code: the emergency and help lines the avatars give, and the age a parent must consent under.
timeZonestring | nullrequiredIANA time zone for dates in safety emails (UTC when null).
safeguardingContactsstring[]requiredUp to 10 email addresses told at once about a safety flag, beside the owners and admins.
privacyNoticeUrlstring | nullrequiredYour privacy notice, linked where people start a conversation.
Errors
invalid_requestunauthorizedforbiddenupgrade_requiredrate_limitedserver_errorcapacity
Request
curl -X PATCH "https://app.zentiqai.com/v1/safety/settings" \
-H "Authorization: Bearer $ZENTIQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'import { Zentiq } from "@zentiq/node";
const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.updateSafeguardingSettings({});import os
from zentiq import Zentiq
zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.update_safeguarding_settings({})Response
{
"data": {
"country": "US",
"timeZone": "America/New_York",
"safeguardingContacts": [
"…"
],
"privacyNoticeUrl": "https://www.example.com"
},
"error": null,
"requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}