Skip to content
campaiDeveloper
campai.com

Crm · Certificates · Types

POST/{organizationId}/crm/certificates/types/confirmation/sampleReads only

Get certificate confirmation properties

Returns permitted native property declarations and synthetic values for the certificate type being edited.

Permissions

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

Permission checks in detail
Also checked, depending on the request and the records it touches
  • certificateType.edit
  • certificateType.insert
  • 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

Body

Content-Type: application/json

  • typeIdidrequirednullable
  • expectedRevisionintegerrequired

    at least 0

  • certificateTypeobjectrequired
    3 properties
    • contactTypestringrequirednullable
      member address customer sponsor contributor employee supplier
    • customFieldsobjectrequirednullable
      5 properties
      • groupsobject[]required
        12 properties
        • idstringrequired

          1–24 characters

        • pageIdstring

          1–24 characters

        • labelstringrequired

          at most 140 characters

        • hintstring

          at most 280 characters

        • fieldsobject[]required
        • disabledboolean | object
          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
        • hiddenboolean | object
          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
        • minItemsinteger

          at least 0

        • maxItemsinteger
        • addItemCaptionstring

          at most 64 characters

        • itemCaptionstring

          at most 100 characters

        • itemModestring
          noHeader draggable
      • pagesobject[]
        3 properties
        • idstringrequired

          1–24 characters

        • labelstringrequired

          1–40 characters

        • hintstring

          at most 280 characters

      • submitCaptionstring
      • appearanceobject
        5 properties
        • accentColorstring
        • accentTextColorstring
        • boxobject
          6 properties
          • borderobject
            3 properties
            • widthnumber
            • colorstring

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

            • radiusnumber
          • backgroundobject
            1 property
            • colorstring

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

          • fontobject
            3 properties
            • colorstring

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

            • sizenumber

              at least 1

            • weightnumber
          • shadowsobject[]
            5 properties
            • xnumberrequired
            • ynumberrequired
            • blurnumberrequired

              at least 0

            • spreadnumberrequired

              at least 0

            • colorstringrequired

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

          • paddingobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

          • marginobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

        • groupBoxobject
          6 properties
          • borderobject
            3 properties
            • widthnumber
            • colorstring

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

            • radiusnumber
          • backgroundobject
            1 property
            • colorstring

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

          • fontobject
            3 properties
            • colorstring

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

            • sizenumber

              at least 1

            • weightnumber
          • shadowsobject[]
            5 properties
            • xnumberrequired
            • ynumberrequired
            • blurnumberrequired

              at least 0

            • spreadnumberrequired

              at least 0

            • colorstringrequired

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

          • paddingobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

          • marginobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

        • inputBoxobject
          8 properties
          • borderobject
            3 properties
            • widthnumber
            • colorstring

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

            • radiusnumber
          • backgroundobject
            1 property
            • colorstring

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

          • fontobject
            3 properties
            • colorstring

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

            • sizenumber

              at least 1

            • weightnumber
          • shadowsobject[]
            5 properties
            • xnumberrequired
            • ynumberrequired
            • blurnumberrequired

              at least 0

            • spreadnumberrequired

              at least 0

            • colorstringrequired

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

          • paddingobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

          • marginobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

          • labelFontobject
            3 properties
            • colorstring

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

            • sizenumber

              at least 1

            • weightnumber
          • heightnumber

            at least 0

      • validationsobject[]
        2 properties
        • conditionobjectrequired
          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
        • messagestring

          1–500 characters

    • namestringrequired

      at most 40 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/certificates/types/confirmation/sample' \
  --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

  • languagestring
  • passConstraintsobjectnullable
    2 properties
    • barcodeobjectnullable
      2 properties
      • formatstring
        qrcode code128 pdf417 aztec
      • contentobject
        1 property
        • variablestring

          at least 1 characters

    • expiresAtobjectnullable
      1 property
      • variablestring

        at least 1 characters

  • fixedPaperFormatobjectnullable
    4 properties
    • unitstring
      px pt mm in
    • widthnumber
    • heightnumber
    • landscapeboolean
  • variablesobject of object
  • propertiesobject of object
  • collectionsobject of object
  • richContentobject of string
    markdown html
  • stackobject of one of 5 types[]
  • displayStackobject of one of 5 types[]
Response200
{
  "language": "string",
  "passConstraints": {
    "barcode": {
      "format": "qrcode",
      "content": {
        "variable": "string"
      }
    },
    "expiresAt": {
      "variable": "string"
    }
  },
  "fixedPaperFormat": {
    "unit": "px",
    "width": 1,
    "height": 1,
    "landscape": true
  },
  "variables": {
    "key": {
      "type": "string"
    }
  },
  "properties": {
    "key": {
      "path": "string",
      "property": {
        "name": "string",
        "format": "string"
      }
    }
  },
  "collections": {
    "key": {
      "path": "string",
      "group": {
        "groupName": "string",
        "properties": {
          "key": {
            "name": "string",
            "format": "string"
          }
        },
        "array": true,
        "name": "string"
      }
    }
  },
  "richContent": {
    "key": "markdown"
  },
  "stack": [
    {
      "key": "string"
    }
  ],
  "displayStack": [
    {
      "key": "string"
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.