Skip to content
campaiDeveloper
campai.com

Crm · Rules

POST/{organizationId}/{mandateId}/crm/rules/actionSampleReads only

Get rule action properties

Returns declared contact and rule properties, including trigger-specific affected properties, for native action editing.

Permissions

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

Permission checks in detail
Required permissions
  • mandate.read
  • { contactRule: input.ruleId ? { edit: true } : { insert: true } }
Also checked, depending on the request and the records it touches
  • 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
  • mandateIdidrequired

Body

Content-Type: application/json

  • ruleIdidrequirednullable
  • contactTypestringrequired
    member address customer sponsor contributor employee supplier
  • triggerobjectrequired
  • typestringrequired
    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/rules/actionSample' \
  --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

  • sampleobject
    9 properties
    • 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[]
  • templateContentsobject
Response200
{
  "sample": {
    "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"
      }
    ]
  },
  "templateContents": {
    "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"
      }
    ]
  }
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.