Skip to content
campaiDeveloper
campai.com

Crm · Mailings

POST/{organizationId}/{mandateId}/crm/mailings/messages/template/copyReads only

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.read
  • dispatchDocument.insert
  • mandate.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • templateIdidrequired
  • channelstringrequired
    email letter
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"
}'

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
    • resourcestring

      at least 1 characters

    • fileNamestring

      at most 128 characters

    • contentTypestring

      at most 75 characters

    • fileSizeBytesinteger

      at least 0

    • idstring

      exactly 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.