Skip to content
campaiDeveloper
campai.com

Templates · Receipt

POST/{organizationId}/templates/receipt/{templateId}

Update receipt template

Update a receipt PDF design, default selection and email settings.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • template.edit
  • receipt.edit

Request

Path parameters

  • organizationIdidrequired
  • templateIdidrequired

Body

Content-Type: application/json

  • propertiesobjectrequired
    10 properties
    • subjectstringrequired

      1–998 characters

    • messagestringrequired

      1–10000 characters

    • refundSubjectstringrequirednullable

      1–998 characters

    • refundMessagestringrequirednullable

      1–10000 characters

    • cancelSubjectstringrequirednullable

      1–998 characters

    • cancelMessagestringrequirednullable

      1–10000 characters

    • standardForstring[]required

      at most 10 items

      invoice invoiceMembershipFee invoiceBooking deposit donation offer confirmation reminder donationReminder returnedPayment
    • emailTemplateidrequirednullable
    • refundEmailTemplateidrequirednullable
    • cancelEmailTemplateidrequirednullable
  • designobjectrequirednullable
    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
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/receipt/YOUR_TEMPLATE_ID' \
  --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

  • defaultsobject of id
    Keys: one of 10 values
    invoice invoiceMembershipFee invoiceBooking deposit donation offer confirmation reminder donationReminder returnedPayment
  • designRevisioninteger

    at least 0

Response200
{
  "defaults": {
    "key": "000000000000000000000001"
  },
  "designRevision": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.