Skip to content
campaiDeveloper
campai.com

Crm · Passes · Templates

POST/{organizationId}/{mandateId}/crm/passes/templates/{templateId}/wallet-design/previewReads only

Preview pass wallet design

Renders an unsaved native pass wallet design with permitted 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.edit
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

Body

Content-Type: application/json

  • expectedRevisionintegerrequired

    at least 0

  • designobjectrequired
  • languagestringrequired

    2–32 characters

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/passes/templates/YOUR_TEMPLATE_ID/wallet-design/preview' \
  --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

  • documentstring
  • resourceUrlsobject of string
Response200
{
  "document": "string",
  "resourceUrls": {
    "key": "string"
  }
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.