Skip to content
campaiDeveloper
campai.com

Templates · Design

POST/{organizationId}/templates/{templateId}/preview/{channel}Reads only

Render design preview

Render a saved or supplied native design using the permitted template properties.

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
Also checked, depending on the request and the records it touches
  • receipt.read
  • donationsSettings.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read

Request

Path parameters

  • organizationIdidrequired
  • templateIdidrequired
  • channelstringrequired
    email letter pass

Body

Content-Type: application/json

  • countrystring
  • onlineLetterboolean
  • languagestring

    2–32 characters

  • canvasstring
    desktop mobile
  • receiptContextstring
    invoice invoiceMembershipFee invoiceBooking deposit donation offer confirmation reminder donationReminder returnedPayment
  • designobjectrequirednullable
    Variant 1: 5 properties
    • versionnumberrequired
    • channelstringrequired
    • containerobjectrequired
      8 properties
      • typestringrequired
      • idstringrequired

        pattern ^[a-zA-Z0-9_-]+$

      • desktopobjectrequired
        1 property
        • paddingany[]required

          exactly 4 items

      • mobileobjectrequired
        1 property
        • paddingany[]requirednullable

          exactly 4 items

      • widthintegerrequired
      • fontFamilystringrequired
        17 values
        System Arial, Helvetica, sans-serif Arial Black, Gadget, sans-serif Comic Sans MS, Textile, Cursive, sans-serif Courier New, Courier, Monospace, monospace Georgia, Times New Roman, Times, serif Helvetica, Arial, serif Impact, Charcoal, sans-serif Lucida Console, Monaco, Monospace, monospace Lucida Sans Unicode, Lucida Grande, sans-serif Palatino Linotype, Book Antiqua, Palatino, serif Tahoma, Geneva, sans-serif Times New Roman, Times, serif Trebuchet MS, Helvetica, sans-serif Verdana, Geneva, sans-serif MS Sans Serif, Geneva, sans-serif MS Serif, New York, serif
      • backgroundobjectrequired
        3 properties
        • backgroundColorobjectrequired
          2 properties
          • colorstringrequired

            pattern ^#[0-9A-F]{6}$

          • hidebooleanrequired
        • backgroundGradientobjectrequired
          3 properties
          • hidebooleanrequired
          • stopsobject[]required
            2 properties
            • colorstringrequired

              pattern ^#[0-9A-F]{6,8}$

            • positionnumberrequired

              at least 0

          • angleintegerrequired
        • backgroundImageobjectrequired
          4 properties
          • hidebooleanrequired
          • imageobjectrequirednullable
          • sizestringrequired
            cover contain fill tile
          • positionstringrequired
            top left top center top right middle left middle center middle right bottom left bottom center bottom right
      • itemsobject[]required
        14 properties
        • idstringrequired

          pattern ^[a-zA-Z0-9_-]+$

        • namestringrequired

          at most 32 characters

        • hideOnMobilebooleanrequired
        • hideOnDesktopbooleanrequired
        • hiddenbooleanrequired
        • lockedbooleanrequired
        • conditionobjectrequirednullable
          2 properties
          • operatorstringrequired
            and or
          • conditions(object (recursive) | object)[]required

            at least 1 items

            4 properties
            • leftobject | object of anyrequired
              Variant 1: 1 property
              • variablestringrequired

                at least 1 characters

              Variant 2: 4 properties
              • sourceobjectrequired
                1 property
                • variablestringrequired

                  at least 1 characters

              • lookupobjectrequirednullable
                1 property
                • variablestringrequired

                  at least 1 characters

              • arraybooleanrequired
              • selectobject (recursive)required
              Variant 3: 2 properties
              • funcstringrequired
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | numberrequired
              Variant 5: 3 properties
              • ifobject (recursive)required
              • thenobject (recursive)required
              • elseobject (recursive)required
            • cmpFuncstringrequired
              15 values
              eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
            • rightobject | object of any
              Variant 1: 1 property
              • variablestringrequired

                at least 1 characters

              Variant 2: 4 properties
              • sourceobjectrequired
                1 property
                • variablestringrequired

                  at least 1 characters

              • lookupobjectrequirednullable
                1 property
                • variablestringrequired

                  at least 1 characters

              • arraybooleanrequired
              • selectobject (recursive)required
              Variant 3: 2 properties
              • funcstringrequired
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | numberrequired
              Variant 5: 3 properties
              • ifobject (recursive)required
              • thenobject (recursive)required
              • elseobject (recursive)required
            • negateboolean
        • desktopobjectrequired
          3 properties
          • marginany[]required

            exactly 4 items

          • paddingany[]required

            exactly 4 items

          • radiusnumber | any[]required
        • mobileobjectrequired
          3 properties
          • marginany[]requirednullable

            exactly 4 items

          • paddingany[]requirednullable

            exactly 4 items

          • radiusnumber | any[]requirednullable
        • typestringrequired
        • repeatobjectrequirednullable
          1 property
          • sourceobjectrequired
            1 property
            • variablestringrequired

              at least 1 characters

        • backgroundobjectrequired
          3 properties
          • backgroundColorobjectrequired
            2 properties
            • colorstringrequired

              pattern ^#[0-9A-F]{6}$

            • hidebooleanrequired
          • backgroundGradientobjectrequired
            3 properties
            • hidebooleanrequired
            • stopsobject[]required
              2 properties
              • colorstringrequired

                pattern ^#[0-9A-F]{6,8}$

              • positionnumberrequired

                at least 0

            • angleintegerrequired
          • backgroundImageobjectrequired
            4 properties
            • hidebooleanrequired
            • imageobjectrequirednullable
            • sizestringrequired
              cover contain fill tile
            • positionstringrequired
              top left top center top right middle left middle center middle right bottom left bottom center bottom right
        • borderobjectrequired
          4 properties
          • colorstringrequired

            pattern ^#[0-9A-F]{6}$

          • widthnumber | any[]required
          • stylestringrequired
            solid dotted dashed
          • hidebooleanrequired
        • itemsobject[]required
    • languagesstring[]required

      at least 1 items · each at least 2 characters

    • resourcesobject[]required
      5 properties
      • resourcestringrequired

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

      • idstringrequired

        exactly 6 characters

    Variant 2: 8 properties
    • versionnumberrequired
    • channelstringrequired
    • containerobjectrequired
      6 properties
      • typestringrequired
      • idstringrequired

        pattern ^[a-zA-Z0-9_-]+$

      • repeatobjectrequirednullable
        1 property
        • sourceobjectrequired
          1 property
          • variablestringrequired

            at least 1 characters

      • pageSizeobjectrequired
        3 properties
        • widthnumberrequired
        • heightnumberrequired
        • landscapebooleanrequired
      • fontFamilystringrequired
      • itemsobject[]required
        11 properties
        • idstringrequired

          pattern ^[a-zA-Z0-9_-]+$

        • namestringrequired

          at most 32 characters

        • hiddenbooleanrequired
        • lockedbooleanrequired
        • conditionobjectrequirednullable
          2 properties
          • operatorstringrequired
            and or
          • conditions(object (recursive) | object)[]required

            at least 1 items

            4 properties
            • leftobject | object of anyrequired
              Variant 1: 1 property
              • variablestringrequired

                at least 1 characters

              Variant 2: 4 properties
              • sourceobjectrequired
                1 property
                • variablestringrequired

                  at least 1 characters

              • lookupobjectrequirednullable
                1 property
                • variablestringrequired

                  at least 1 characters

              • arraybooleanrequired
              • selectobject (recursive)required
              Variant 3: 2 properties
              • funcstringrequired
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | numberrequired
              Variant 5: 3 properties
              • ifobject (recursive)required
              • thenobject (recursive)required
              • elseobject (recursive)required
            • cmpFuncstringrequired
              15 values
              eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
            • rightobject | object of any
              Variant 1: 1 property
              • variablestringrequired

                at least 1 characters

              Variant 2: 4 properties
              • sourceobjectrequired
                1 property
                • variablestringrequired

                  at least 1 characters

              • lookupobjectrequirednullable
                1 property
                • variablestringrequired

                  at least 1 characters

              • arraybooleanrequired
              • selectobject (recursive)required
              Variant 3: 2 properties
              • funcstringrequired
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | numberrequired
              Variant 5: 3 properties
              • ifobject (recursive)required
              • thenobject (recursive)required
              • elseobject (recursive)required
            • negateboolean
        • typestringrequired
        • repeatobjectrequirednullable
          1 property
          • sourceobjectrequired
            1 property
            • variablestringrequired

              at least 1 characters

        • marginany[]required

          exactly 4 items

        • backgroundobjectrequired
          3 properties
          • backgroundColorobjectrequired
            2 properties
            • colorstringrequired

              pattern ^#[0-9A-F]{6}$

            • hidebooleanrequired
          • backgroundGradientobjectrequired
            3 properties
            • hidebooleanrequired
            • stopsobject[]required
              2 properties
              • colorstringrequired

                pattern ^#[0-9A-F]{6,8}$

              • positionnumberrequired

                at least 0

            • angleintegerrequired
          • backgroundImageobjectrequired
            4 properties
            • hidebooleanrequired
            • imageobjectrequirednullable
            • sizestringrequired
              cover contain fill tile
            • positionstringrequired
              top left top center top right middle left middle center middle right bottom left bottom center bottom right
        • foldingMarksobject[]required
          3 properties
          • topnumberrequired
          • leftnumberrequired
          • widthnumberrequired
        • itemsobject[]required
    • unitstringrequired
      px pt mm in
    • languagesstring[]required

      at least 1 items · each at least 2 characters

    • onlineLetterbooleanrequired
    • resourcesobject[]required
      5 properties
      • resourcestringrequired

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

      • idstringrequired

        exactly 6 characters

    • attachmentobjectrequirednullable
      3 properties
      • resourceIdstringrequired

        exactly 6 characters

      • modestringrequired
        overlay prepend append
      • pagesintegerrequired
  • draftboolean
  • recipientstring | object
    1 property
    • contactIdidrequired
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/preview/YOUR_CHANNEL' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • resourceUrlsobject of string
  • documentstring
  • widthnumber
  • pagesnumber
Response200
{
  "resourceUrls": {
    "key": "string"
  },
  "document": "string"
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.