Skip to content
campaiDeveloper
campai.com

Crm · Passes · Templates

GET/{organizationId}/{mandateId}/crm/passes/templates/{templateId}/wallet-designReads only

Get pass wallet design

Returns the native wallet design and permitted synthetic composition sample without changing the template.

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
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/wallet-design' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • designobject
  • 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[]
  • designRevisioninteger

    at least 0

Response200
{
  "design": {
    "version": 1,
    "channel": "pass",
    "id": "string",
    "languages": [
      "string"
    ],
    "resources": [
      {
        "resource": "string",
        "id": "string"
      }
    ],
    "isSingleUse": true,
    "expiresAt": {
      "variable": "string"
    },
    "locations": [
      {
        "latitude": -90,
        "longitude": -180
      }
    ],
    "issuerName": {
      "mode": "plain",
      "values": {
        "key": [
          {
            "kind": "literal",
            "value": "string"
          }
        ]
      },
      "fallbackLanguage": "string"
    },
    "logoImage": {
      "type": "resource",
      "resourceId": "string"
    },
    "mainImage": {
      "type": "resource",
      "resourceId": "string"
    },
    "textFields": {
      "key": {
        "type": "header",
        "label": {
          "mode": "plain",
          "values": {
            "key": [
              {
                "kind": "literal",
                "value": "string"
              }
            ]
          },
          "fallbackLanguage": "string"
        },
        "value": {
          "mode": "plain",
          "values": {
            "key": [
              {
                "kind": "literal",
                "value": "string"
              }
            ]
          },
          "fallbackLanguage": "string"
        }
      }
    },
    "barcode": {
      "format": "qrcode",
      "content": {
        "mode": "plain",
        "values": {
          "key": [
            {
              "kind": "literal",
              "value": "string"
            }
          ]
        },
        "fallbackLanguage": "string"
      },
      "text": {
        "mode": "plain",
        "values": {
          "key": [
            {
              "kind": "literal",
              "value": "string"
            }
          ]
        },
        "fallbackLanguage": "string"
      }
    },
    "apple": {
      "showIssuerName": true,
      "textColor": "string",
      "hideMainFields": true
    },
    "google": {
      "renderWideLogo": true
    },
    "type": "custom",
    "custom": {
      "header": {
        "mode": "plain",
        "values": {
          "key": [
            {
              "kind": "literal",
              "value": "string"
            }
          ]
        },
        "fallbackLanguage": "string"
      },
      "subheader": {
        "mode": "plain",
        "values": {
          "key": [
            {
              "kind": "literal",
              "value": "string"
            }
          ]
        },
        "fallbackLanguage": "string"
      },
      "backgroundColor": {
        "mode": "plain",
        "values": {
          "key": [
            {
              "kind": "literal",
              "value": "string"
            }
          ]
        },
        "fallbackLanguage": "string"
      }
    }
  },
  "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"
      }
    ]
  },
  "designRevision": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.