Crm · Contacts
Copy message template
Copies a published contact or transactional content template into temporary message resources. Provide the organization, mandate and template IDs and an email or letter channel. The response contains the design and its copied resources, plus copied email attachments when applicable.
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 with
template.readanddispatchDocument.insertpermissions. - The caller must also have
mandate.readpermission for the supplied mandate.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
templateIdidrequired -
channelstringrequiredemailletter
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/contacts/message/template/copy' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/contacts/message/template/copy", {
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/YOUR_MANDATE_ID/crm/contacts/message/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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
designobjectVariant 1: 5 properties
-
versionnumber -
channelstring -
containerobject8 properties
-
typestring -
idstringpattern
^[a-zA-Z0-9_-]+$ -
desktopobject1 property
-
paddingany[]exactly 4 items
-
-
mobileobject1 property
-
paddingany[]nullableexactly 4 items
-
-
widthinteger -
fontFamilystring17 values
SystemArial, Helvetica, sans-serifArial Black, Gadget, sans-serifComic Sans MS, Textile, Cursive, sans-serifCourier New, Courier, Monospace, monospaceGeorgia, Times New Roman, Times, serifHelvetica, Arial, serifImpact, Charcoal, sans-serifLucida Console, Monaco, Monospace, monospaceLucida Sans Unicode, Lucida Grande, sans-serifPalatino Linotype, Book Antiqua, Palatino, serifTahoma, Geneva, sans-serifTimes New Roman, Times, serifTrebuchet MS, Helvetica, sans-serifVerdana, Geneva, sans-serifMS Sans Serif, Geneva, sans-serifMS Serif, New York, serif -
backgroundobject3 properties
-
backgroundColorobject2 properties
-
colorstringpattern
^#[0-9A-F]{6}$ -
hideboolean
-
-
backgroundGradientobject3 properties
-
hideboolean -
stopsobject[]2 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
positionnumberat least 0
-
-
angleinteger
-
-
backgroundImageobject4 properties
-
hideboolean -
imageobjectnullable -
sizestringcovercontainfilltile -
positionstringtop lefttop centertop rightmiddle leftmiddle centermiddle rightbottom leftbottom centerbottom right
-
-
-
itemsobject[]14 properties
-
idstringpattern
^[a-zA-Z0-9_-]+$ -
namestringat most 32 characters
-
hideOnMobileboolean -
hideOnDesktopboolean -
hiddenboolean -
lockedboolean -
conditionobjectnullable2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
desktopobject3 properties
-
marginany[]exactly 4 items
-
paddingany[]exactly 4 items
-
radiusnumber | any[]
-
-
mobileobject3 properties
-
marginany[]nullableexactly 4 items
-
paddingany[]nullableexactly 4 items
-
radiusnumber | any[]nullable
-
-
typestring -
repeatobjectnullable1 property
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
-
backgroundobject3 properties
-
backgroundColorobject2 properties
-
colorstringpattern
^#[0-9A-F]{6}$ -
hideboolean
-
-
backgroundGradientobject3 properties
-
hideboolean -
stopsobject[]2 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
positionnumberat least 0
-
-
angleinteger
-
-
backgroundImageobject4 properties
-
hideboolean -
imageobjectnullable -
sizestringcovercontainfilltile -
positionstringtop lefttop centertop rightmiddle leftmiddle centermiddle rightbottom leftbottom centerbottom right
-
-
-
borderobject4 properties
-
colorstringpattern
^#[0-9A-F]{6}$ -
widthnumber | any[] -
stylestringsoliddotteddashed -
hideboolean
-
-
itemsobject[]
-
-
-
languagesstring[]at least 1 items · each at least 2 characters
-
resourcesobject[]5 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
idstringexactly 6 characters
-
Variant 2: 8 properties
-
versionnumber -
channelstring -
containerobject6 properties
-
typestring -
idstringpattern
^[a-zA-Z0-9_-]+$ -
repeatobjectnullable1 property
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
-
pageSizeobject3 properties
-
widthnumber -
heightnumber -
landscapeboolean
-
-
fontFamilystring -
itemsobject[]11 properties
-
idstringpattern
^[a-zA-Z0-9_-]+$ -
namestringat most 32 characters
-
hiddenboolean -
lockedboolean -
conditionobjectnullable2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
typestring -
repeatobjectnullable1 property
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
-
marginany[]exactly 4 items
-
backgroundobject3 properties
-
backgroundColorobject2 properties
-
colorstringpattern
^#[0-9A-F]{6}$ -
hideboolean
-
-
backgroundGradientobject3 properties
-
hideboolean -
stopsobject[]2 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
positionnumberat least 0
-
-
angleinteger
-
-
backgroundImageobject4 properties
-
hideboolean -
imageobjectnullable -
sizestringcovercontainfilltile -
positionstringtop lefttop centertop rightmiddle leftmiddle centermiddle rightbottom leftbottom centerbottom right
-
-
-
foldingMarksobject[]3 properties
-
topnumber -
leftnumber -
widthnumber
-
-
itemsobject[]
-
-
-
unitstringpxptmmin -
languagesstring[]at least 1 items · each at least 2 characters
-
onlineLetterboolean -
resourcesobject[]5 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
idstringexactly 6 characters
-
-
attachmentobjectnullable3 properties
-
resourceIdstringexactly 6 characters
-
modestringoverlayprependappend -
pagesinteger
-
-
-
attachmentsobject[]attachmentsis empty for theletterchannel.5 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
idstringexactly 6 characters
-
{
"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"
}
]
}
What else happens
- Copies design resources and, for email, attachments to temporary storage.
- If copying fails, the endpoint attempts to remove the temporary resources created during the request.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | No fixed message | Returns HTTP 400 if the template has no design for the requested channel. |
| 400 | No fixed message | Returns HTTP 400 if a resource path is outside the template's resource prefix or contains a .. path segment. |
| 404 | No fixed message | Returns HTTP 404 if the template is not found, is archived or unpublished, or is not a contact or transactional content template. |
| 404 | No fixed message | Returns HTTP 404 if a resource cannot be copied. |
Errors nearly every request can meet are listed under Errors.