Skip to main content

Issue a pass

POST /passes/issue

Issues a pass to an existing member. Use this endpoint for standard member passes and for event ticket passes when the ticket recipient is already a member. Requires the passes:issue permission.

Note

Use this endpoint when the recipient is already a RemyPass member. For standard member passes, provide memberId and passTemplateId, plus optional expiryDate, customFields, and sendEmail. For event ticket passes, use a pre-created event ticket template and include eventTime, eventName, and seatInfo.

Authorization

X-API-Key required

Request Body

FieldTypeRequiredDescription
memberIdstringYesMember id to issue the pass to. Use the member _id returned by member endpoints, not your external memberId.
passTemplateIdstringYesPass template id to issue. Use the id from the List pass templates endpoint.
expiryDatestring (date-time)NoOptional pass expiry date.
customFieldsobjectNoCustom field values to store on the issued pass.
sendEmailbooleanNoDefaults to true. Set to false to issue the pass without sending the pass email.
eventTimestring (date-time)NoEvent start time for event ticket pass templates. Required when issuing an event ticket pass.
eventNamestringNoEvent name displayed on event ticket passes. Required when issuing an event ticket pass.
seatInfoobjectNoSeat, row, and section details for event ticket passes. Required when issuing an event ticket pass.

Request Examples

curl -X POST "https://api.remypass.com/api/v1/public/passes/issue" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "memberId": "507f1f77bcf86cd799439011",
  "passTemplateId": "507f1f77bcf86cd799439011",
  "expiryDate": "2026-01-01T12:00:00.000Z",
  "customFields": {
    "membershipLevel": "Gold",
    "favoriteLocation": "Main Street",
    "newsletterOptIn": true
  },
  "sendEmail": true,
  "eventTime": "2026-01-01T12:00:00.000Z",
  "eventName": "string",
  "seatInfo": {
    "seat": "string",
    "section": "string",
    "row": "string"
  }
}'

Use Case Examples

Issue a pass to a member

Use this for standard member pass templates.

curl -X POST https://api.remypass.com/api/v1/public/passes/issue \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"memberId": "507f1f77bcf86cd799439011",
"passTemplateId": "507f1f77bcf86cd799439012",
"expiryDate": "2024-12-31T23:59:59.000Z",
"customFields": {
"membershipLevel": "Premium",
"accessLevel": "VIP",
"issueDate": "2024-01-15"
},
"sendEmail": true
}'

Issue an event ticket pass to a member

Use this when the ticket recipient is already a member. Requires a pre-created event ticket template.

curl -X POST https://api.remypass.com/api/v1/public/passes/issue \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"memberId": "507f1f77bcf86cd799439011",
"passTemplateId": "507f1f77bcf86cd799439012",
"eventTime": "2024-12-25T19:30:00.000Z",
"eventName": "The Matrix Reloaded",
"seatInfo": {
"seat": "A12",
"row": "A",
"section": "Screen 1"
},
"sendEmail": true
}'

Responses

StatusDescription
201Pass issued.
400Bad request or validation error.
401Missing or invalid API key.
403The caller is not allowed to access this resource.
500Server error.

Response Fields

FieldTypeAttributes
successboolean
messagestring
dataobject
Show child attributes
  • _id: string
  • serialNumber: string
  • status: active, inactive, expired, void
  • member: string or object
    Show child attributes
    • _id: string
    • title: Mr, Ms, Mrs, Miss, Sir, Madam, Dr, Rev
    • name: string
    • email: string (email)
    • memberId: string
    • type: Member, Visitor
    • status: active, inactive
    • customFields: object
    • passes: integer
    • createdAt: string (date-time)
    • updatedAt: string (date-time)
  • pass: string or object
    Show child attributes
    • _id: string
    • name: string
    • description: string
    • type: string
    • approved: boolean
    • design: object
      Show child attributes
      • backgroundColor: string
      • foregroundColor: string
      • labelColor: string
      • voidedBackgroundColor: string
      • logoText: string
      • icon: string (uri)
      • appleLogo: string (uri)
      • googleLogo: string (uri)
      • googleWideLogo: string (uri)
      • heroImage: string (uri)
      • stripImage: string (uri)
      • colorVariants: array of object
    • loyalty: object
      Show child attributes
      • initialStamps: integer
      • maxStamps: integer
      • emptyStampIconBgColor: string
      • filledStampIcon: string (uri)
      • filledStampIconBgColor: string
      • rewardIcon: string (uri)
      • stripBackgroundColor: string
      • stripBackgroundImage: string (uri)
      • stampShape: circle, rounded, square
      • issueRewards: boolean
      • deactivateOnMaxStamps: boolean
      • rewardTitle: string
      • rewardDescription: string
      • stampSingular: string
      • stampPlural: string
  • recipientName: string
  • recipientEmail: string (email)
  • expiryDate: string (date-time)
  • issuedAt: string (date-time)
  • walletUrls: object
    Show child attributes
    • apple: string (uri)
    • google: string (uri)