Skip to content
campaiDeveloper
campai.com

Crm · Passes

GET/{organizationId}/{mandateId}/crm/passes/{issuedPassId}/previewReads only

Preview issued pass

Renders the issued pass snapshot with the current authorized wallet or print design.

Permissions

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

Permission checks in detail
Required permissions
  • contactIssuedPass.read
  • 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
  • issuedPassIdidrequired

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/YOUR_ISSUED_PASS_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.