Create a member

POST /members

Requires the members:write permission.

Authorization

X-API-Key required

Request Body

Field	Type	Required	Description
title	Mr, Ms, Mrs, Miss, Sir, Madam, Dr, Rev	No	Optional member title or honorific.
name	string	Yes	Member full name.
email	string (email)	Yes	Member email address. Used for pass delivery emails when a pass is issued.
memberId	string	No	Unique member identifier. Must not contain spaces.
type	Member, Visitor	No	Member category. Defaults to Member when omitted.
status	active, inactive	No	Member account status. Defaults to active when omitted.
customFields	object	No	Organisation-defined custom field values keyed by custom field key.
issuePass	boolean	No	Set to true to issue a pass immediately after creating the member.
passTemplateId	string	No	Required when issuePass is true. Use the id from the List pass templates endpoint.
expiryDate	string (date-time)	No	Optional pass expiry date used when issuePass is true.

Request Examples

curl -X POST "https://api.remypass.com/api/v1/public/members" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Mr",
  "name": "John Doe",
  "email": "john@example.com",
  "memberId": "string",
  "type": "Member",
  "status": "active",
  "customFields": {
    "membershipLevel": "Gold",
    "favoriteLocation": "Main Street",
    "newsletterOptIn": true
  },
  "issuePass": true,
  "passTemplateId": "507f1f77bcf86cd799439011",
  "expiryDate": "2026-01-01T12:00:00.000Z"
}'

Use Case Examples

Create a new member

curl -X POST https://api.remypass.com/api/v1/public/members \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dr. Sarah Johnson",
    "email": "sarah.johnson@example.com",
    "title": "Dr",
    "memberId": "MEM001",
    "type": "Member",
    "status": "active",
    "customFields": {
      "department": "Engineering",
      "membershipLevel": "Premium"
    }
  }'

Create member with immediate pass issuance

curl -X POST https://api.remypass.com/api/v1/public/members \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Ms",
    "name": "Emily Chen",
    "email": "emily.chen@example.com",
    "memberId": "MEM002",
    "issuePass": true,
    "passTemplateId": "507f1f77bcf86cd799439012",
    "expiryDate": "2024-12-31T23:59:59.000Z"
  }'

Responses

Status	Description
201	Member created.
400	Bad request or validation error.
401	Missing or invalid API key.
403	The caller is not allowed to access this resource.
500	Server error.

Response Fields

Field	Type	Attributes
success	boolean
message	string
data	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)