Crm · Mailings
Copy message template
Copies a published contact or transactional content template into temporary message resources.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
template.readdispatchDocument.insertmandate.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
templateIdidrequired -
channelstringrequiredemailletter
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/mailings/messages/template/copy' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"templateId": "6b01bd609a14acdaad4922dd",
"channel": "letter"
}'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/mailings/messages/template/copy", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
"templateId": "6b01bd609a14acdaad4922dd",
"channel": "letter"
}),
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
$body = [
'templateId' => '6b01bd609a14acdaad4922dd',
'channel' => 'letter',
];
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
'Content-Type: application/json',
],
'content' => json_encode($body, JSON_THROW_ON_ERROR),
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/mailings/messages/template/copy', 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;
A request the admin app sent for “Send a member a letter from a template”.
Response
200 Successful response
Content-Type: application/json
-
designobject -
attachmentsobject[]5 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
idstringexactly 6 characters
-
Response200
{
"design": {
"version": 1,
"channel": "email",
"container": {
"type": "container",
"id": "string",
"desktop": {
"padding": [
null
]
},
"mobile": {
"padding": [
null
]
},
"width": 1,
"fontFamily": "System",
"background": {
"backgroundColor": {
"color": "string",
"hide": true
},
"backgroundGradient": {
"hide": true,
"stops": [
{
"color": "string",
"position": 0
}
],
"angle": 1
},
"backgroundImage": {
"hide": true,
"image": {
"type": "resource",
"resourceId": "string"
},
"size": "cover",
"position": "top left"
}
},
"items": [
{
"id": "string",
"name": "string",
"hideOnMobile": true,
"hideOnDesktop": true,
"hidden": true,
"locked": true,
"condition": {
"operator": "and",
"conditions": [
null
]
},
"desktop": {
"margin": [
null
],
"padding": [
null
],
"radius": 0
},
"mobile": {
"margin": [
null
],
"padding": [
null
],
"radius": 0
},
"type": "block",
"repeat": {
"source": {
"variable": "string"
}
},
"background": {
"backgroundColor": {
"color": "string",
"hide": true
},
"backgroundGradient": {
"hide": true,
"stops": [
{
"color": "string",
"position": 0
}
],
"angle": 1
},
"backgroundImage": {
"hide": true,
"image": {
"type": "resource",
"resourceId": "string"
},
"size": "cover",
"position": "top left"
}
},
"border": {
"color": "string",
"width": 0,
"style": "solid",
"hide": true
},
"items": [
{
"id": "string",
"name": "string",
"hideOnMobile": true,
"hideOnDesktop": true,
"hidden": true,
"locked": true,
"condition": {
"operator": "and",
"conditions": [
null
]
},
"desktop": {
"width": {
"type": "hug",
"width": {
"value": 0,
"unit": "#"
}
}
},
"mobile": {
"width": {
"type": "hug",
"width": {
"value": null,
"unit": "#"
}
}
},
"type": "table",
"align": "left",
"border": {
"color": "string",
"width": 0,
"style": "solid",
"hide": true
},
"collapseMobile": true,
"items": [
{
"id": "string",
"name": "string",
"hideOnMobile": true,
"hideOnDesktop": true,
"hidden": true,
"locked": true,
"condition": null,
"desktop": {
"placement": "top left",
"height": {
"value": null,
"unit": "#"
}
},
"mobile": {
"placement": "top left",
"height": null
},
"type": "tableRow",
"repeat": {
"source": null
},
"backgroundColor": {
"color": "string",
"hide": true
},
"border": {
"color": "string",
"width": null,
"style": "solid",
"hide": true
},
"items": [
{
"id": null,
"name": null,
"hideOnMobile": null,
"hideOnDesktop": null,
"hidden": null,
"locked": null,
"condition": null,
"desktop": null,
"mobile": null,
"type": "tableCell",
"background": null,
"items": null
}
]
}
]
}
]
}
]
},
"languages": [
"string"
],
"resources": [
{
"resource": "string",
"id": "string"
}
]
},
"attachments": [
{
"resource": "string",
"id": "string"
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.