Templates
Update template info
Updates a template’s name, description and folder using the organization ID, template ID and folder ID. The folder ID can be null. Returns the template’s name, description, folder and updatedAt.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access and the
template.editpermission. - Updating a
receipttemplate also requiresreceipt.edit. - Updating a
donationConfirmationtemplate also requiresdonationsSettings.edit.
Request
Path parameters
-
organizationIdidrequired -
templateIdidrequired
Body
Content-Type: application/json
-
namestringrequired1–64 characters
-
descriptionstringrequiredat most 240 characters
-
folderIdidrequirednullable
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/YOUR_TEMPLATE_ID/info' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/YOUR_TEMPLATE_ID/info", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/YOUR_TEMPLATE_ID/info', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
namestring1–64 characters
-
descriptionstringat most 240 characters
-
folderidnullable -
updatedAtstring · date-timenullable
Response200
{
"name": "string",
"description": "string",
"folder": "000000000000000000000001"
}
What else happens
- When a folder is supplied and found, its
templateFoldersrecord is updated with its existing name. - The template’s
name,descriptionandfolderare updated.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | No fixed message | If the template is not found in the organization, the request returns HTTP 404 NOT_FOUND. |
| 404 | No fixed message | If a folder ID is supplied but the folder is not found in the organization, the request returns HTTP 404 NOT_FOUND. |
Errors nearly every request can meet are listed under Errors.