Skip to content
campaiDeveloper
campai.com

Crm · Mailings

GET/{organizationId}/{mandateId}/crm/mailings/{mailingId}/sampleReads only

Get mailing properties

Returns permitted native property declarations and synthetic values for an authorized mailing.

Permissions

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

Permission checks in detail
Required permissions
  • mailing.read
Also checked, depending on the request and the records it touches
  • mandate.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
  • mandateIdidrequired
  • mailingIdidrequired

Query parameters

  • contactTypestringnullable
    member address customer sponsor contributor employee supplier
  • sharedSegmentstringnullable

    1–30 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/mailings/YOUR_MAILING_ID/sample' \
  --header 'X-API-Key: YOUR_API_KEY'

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.