Skip to content
campaiDeveloper
campai.com

Crm · Passes · Templates

GET/{organizationId}/{mandateId}/crm/passes/templates/{templateId}/previewReads only

Preview saved pass template

Renders a saved wallet or printable pass design with permitted sample properties and owner-scoped assets.

Permissions

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

Permission checks in detail
Required permissions
  • contactPassTemplate.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
  • templateIdidrequired

Query parameters

  • channelstringrequired
    wallet print
  • languagestringrequired

    2–32 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/passes/templates/YOUR_TEMPLATE_ID/preview' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • typestring
    html pdf
  • documentstring
Response200
{
  "type": "html",
  "document": "string"
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.