Create a member

POST /members

Requires the members:write permission. The response data contains member, passInstance and assignment outcome flags. Member creation can succeed even if optional pass or membership assignment fails; inspect passIssued and membershipGrantFailed.

Authorization

X-API-Key required

Request Body

Field	Type	Required	Limits	Description
title	Mr, Ms, Mrs, Miss, Sir, Madam, Dr, Rev	No		Optional member title or honorific.
name	string	Yes	min length 1	Member full name. Required by the public API. firstName and lastName may also be provided and are stored separately.
firstName	string	No	max length 120	Optional member first name stored separately from the full name.
lastName	string	No	max length 120	Optional member last name stored separately from the full name.
email	string (email)	Yes		Member email address. Used for pass delivery emails when a pass is issued.
address	object	No
contactPreferences	object	No
memberId	string	No		Unique member identifier. Must not contain spaces.
memberSince	string (date-time)	No		Date the member joined. Defaults to now when omitted.
type	Member, Visitor	No		Member category. Defaults to Member when omitted.
status	active, inactive	No		Accepted by route validation, but newly created members are stored as active. Use PUT /members/{id} to change status
location	string	No	max length 100	Member location or branch.
phone	string	No	max length 50	Member phone number.
dateOfBirth	string (date)	No		Member date of birth.
gender	male, female, other, prefer_not_to_say	No		Member gender.
notes	string	No	max length 5000	Internal member notes.
flagged	boolean	No		Whether the member is flagged for staff attention.
flagNote	string	No	max length 500	Optional note shown when the member is flagged.
customFields	object	No		Organisation-defined custom field values keyed by custom field key. Use customFields only for fields configured by the organisation; use first-party fields such as phone, dateOfBirth, gender, and notes at the top level.
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.
photo	string	No		Base64 image data URL. On update, an empty string removes the photo and existing URLs leave it unchanged
membershipTypeId	string	No		Optional membership assignment after saving the member
membershipPricingOptionId	string	No		Pricing option id within the selected membership type
membershipManualPayment	object	No
expiryDateFieldKey	string	No		Visible date custom field used for pass expiry; takes precedence over expiryDate 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",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "address": {
    "addressLine1": "23 Gastons Road",
    "addressLine2": "",
    "city": "London",
    "region": "Greater London",
    "postalCode": "SW1A 1AA",
    "country": "United Kingdom"
  },
  "contactPreferences": {
    "email": true,
    "post": true,
    "phone": true
  },
  "memberId": "string",
  "memberSince": "2026-01-01T12:00:00.000Z",
  "type": "Member",
  "status": "active",
  "location": "Main Street",
  "phone": "+447700900123",
  "dateOfBirth": "1990-04-20",
  "gender": "male",
  "notes": "Prefers email contact",
  "flagged": true,
  "flagNote": "Check eligibility before issuing renewal",
  "customFields": {
    "membershipLevel": "Gold",
    "favoriteLocation": "Main Street",
    "newsletterOptIn": true
  },
  "issuePass": true,
  "passTemplateId": "507f1f77bcf86cd799439011",
  "expiryDate": "2026-01-01T12:00:00.000Z",
  "photo": "string",
  "membershipTypeId": "507f1f77bcf86cd799439011",
  "membershipPricingOptionId": "string",
  "membershipManualPayment": {
    "method": "cash",
    "amount": 1,
    "currency": "507f1f77bcf86cd799439011",
    "reference": "string",
    "notes": "string"
  },
  "expiryDateFieldKey": "string"
}'

Use Case Examples

Create a new member

curl -X POST https://api.remypass.com/api/v1/public/members \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dr. Sarah Johnson",
    "firstName": "Sarah",
    "lastName": "Johnson",
    "email": "sarah.johnson@example.com",
    "title": "Dr",
    "memberId": "MEM001",
    "memberSince": "2024-01-15T00:00:00.000Z",
    "phone": "+447700900123",
    "dateOfBirth": "1990-04-20",
    "gender": "female",
    "notes": "Prefers email contact",
    "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 "X-API-Key: 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. The top-level message explains what is invalid and, where applicable, the errors array contains structured field details.
401	Missing or invalid API key.
403	The caller is not allowed to access this resource.
429	Rate limit exceeded.
500	Server error.

201 Response Example

{
  "success": true,
  "message": "string",
  "data": {
    "member": {
      "_id": "507f1f77bcf86cd799439011",
      "title": "Mr",
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com",
      "address": {
        "addressLine1": "23 Gastons Road",
        "addressLine2": "",
        "city": "London",
        "region": "Greater London",
        "postalCode": "SW1A 1AA",
        "country": "United Kingdom"
      },
      "contactPreferences": {
        "email": true,
        "post": true,
        "phone": true
      },
      "memberId": "MEM001",
      "memberSince": "2024-01-15T00:00:00.000Z",
      "type": "Member",
      "status": "active",
      "location": "Main Street",
      "phone": "+447700900123",
      "dateOfBirth": "1990-04-20",
      "gender": "male",
      "notes": "Prefers email contact",
      "flagged": true,
      "flagNote": "Check eligibility before issuing renewal",
      "customFields": {
        "membershipLevel": "Gold",
        "favoriteLocation": "Main Street",
        "newsletterOptIn": true
      },
      "passes": [
        {
          "passInstance": {},
          "issuedAt": null,
          "issuedBy": null,
          "status": null,
          "expiryDate": null
        }
      ],
      "createdAt": "2026-01-01T12:00:00.000Z",
      "updatedAt": "2026-01-01T12:00:00.000Z",
      "walletSummary": {
        "total": 1,
        "added": 1,
        "status": "no_pass"
      },
      "photo": "string",
      "linkedMemberGroupId": "507f1f77bcf86cd799439011"
    },
    "passInstance": {
      "_id": "507f1f77bcf86cd799439013",
      "serialNumber": "string",
      "status": "active",
      "member": "string",
      "pass": "string",
      "recipientName": "string",
      "recipientEmail": "user@example.com",
      "expiryDate": "2026-01-01T12:00:00.000Z",
      "issuedAt": "2026-01-01T12:00:00.000Z",
      "walletUrls": {
        "apple": "string",
        "google": "string"
      },
      "maxUses": 1,
      "usesRemaining": 1,
      "redeemedCount": 1,
      "lastRedeemedAt": "2026-01-01T12:00:00.000Z",
      "passType": "generic",
      "customFields": {},
      "eventTime": "2026-01-01T12:00:00.000Z",
      "eventName": "string",
      "seatInfo": {
        "seat": "string",
        "section": "string",
        "row": "string",
        "gate": "string"
      },
      "recipientTitle": "string",
      "voided": true,
      "voidedAt": "2026-01-01T12:00:00.000Z",
      "isNonMemberTicket": true,
      "currentStamps": 1,
      "lifetimeStampsEarned": 1,
      "lastStampUpdate": "2026-01-01T12:00:00.000Z",
      "createdAt": "2026-01-01T12:00:00.000Z",
      "updatedAt": "2026-01-01T12:00:00.000Z",
      "membershipManaged": true,
      "memberMembershipId": "string"
    },
    "passIssued": true,
    "membershipGrant": {},
    "membershipGranted": true,
    "membershipGrantFailed": true,
    "membershipGrantError": "string",
    "message": "string"
  }
}

Response Fields

Field	Type	Description	Attributes
success	boolean
message	string
data	object		Show child attributes member: object Show child attributes _id: string title: Mr, Ms, Mrs, Miss, Sir, Madam, Dr, Rev — Optional member title or honorific. name: string — Member full name. firstName: string — Member first name. lastName: string — Member last name. email: string (email) — Member email address. Used for pass delivery emails when a pass is issued. address: object Show child attributes addressLine1: string addressLine2: string city: string region: string — State, county, province, or region. postalCode: string country: string — Country name or ISO country code. contactPreferences: object — Optional marketing communication preferences. Essential service communications are unaffected. Show child attributes email: boolean post: boolean phone: boolean memberId: string — External or organisation-defined member identifier. memberSince: string (date-time) — Date the member joined. Defaults to the creation date when omitted. type: Member, Visitor — Member category. Defaults to Member when omitted. status: active, inactive — Member account status. Defaults to active when omitted. location: string — Member location or branch. phone: string — Member phone number. dateOfBirth: string (date-time) — Member date of birth. gender: male, female, other, prefer_not_to_say — Member gender. notes: string — Internal member notes. flagged: boolean — Whether the member is flagged for staff attention. flagNote: string — Optional note shown when the member is flagged. customFields: object — Organisation-defined custom field values keyed by custom field key. Use customFields only for fields configured by the organisation; use first-party fields such as phone, dateOfBirth, gender, and notes at the top level. passes: array of object — Pass wrappers included by member list and lookup endpoints Show child attributes passInstance: object issuedAt: string (date-time) issuedBy: string or object status: active, inactive, expired, void expiryDate: string (date-time) createdAt: string (date-time) updatedAt: string (date-time) walletSummary: object — Included on member list responses Show child attributes total: integer added: integer status: no_pass, added, not_added photo: string — Stored member photo URL linkedMemberGroupId: string passInstance: object 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 — Optional member title or honorific. name: string — Member full name. firstName: string — Member first name. lastName: string — Member last name. email: string (email) — Member email address. Used for pass delivery emails when a pass is issued. address: object contactPreferences: object — Optional marketing communication preferences. Essential service communications are unaffected. memberId: string — External or organisation-defined member identifier. memberSince: string (date-time) — Date the member joined. Defaults to the creation date when omitted. type: Member, Visitor — Member category. Defaults to Member when omitted. status: active, inactive — Member account status. Defaults to active when omitted. location: string — Member location or branch. phone: string — Member phone number. dateOfBirth: string (date-time) — Member date of birth. gender: male, female, other, prefer_not_to_say — Member gender. notes: string — Internal member notes. flagged: boolean — Whether the member is flagged for staff attention. flagNote: string — Optional note shown when the member is flagged. customFields: object — Organisation-defined custom field values keyed by custom field key. Use customFields only for fields configured by the organisation; use first-party fields such as phone, dateOfBirth, gender, and notes at the top level. passes: array of object — Pass wrappers included by member list and lookup endpoints createdAt: string (date-time) updatedAt: string (date-time) walletSummary: object — Included on member list responses photo: string — Stored member photo URL linkedMemberGroupId: string pass: string or object Show child attributes _id: string name: string description: string type: generic, eventTicket, loyalty approved: boolean design: object — Visual design settings used when rendering Apple Wallet and Google Wallet passes. loyalty: object — Loyalty pass configuration. Present for loyalty pass templates. recipientName: string recipientEmail: string (email) expiryDate: string (date-time) issuedAt: string (date-time) walletUrls: object Show child attributes apple: string (uri) google: string (uri) maxUses: integer — Maximum number of successful scans allowed for an event ticket. Defaults to 1 for tickets issued before multi-use support or when omitted. usesRemaining: integer — Remaining successful scans available on an event ticket. redeemedCount: integer — Number of successful event ticket redemptions. lastRedeemedAt: string (date-time) — Timestamp of the latest successful event ticket redemption. passType: generic, eventTicket, loyalty customFields: object eventTime: string (date-time) eventName: string seatInfo: object Show child attributes seat: string section: string row: string gate: string — Optional event ticket gate recipientTitle: string voided: boolean voidedAt: string (date-time) isNonMemberTicket: boolean currentStamps: number lifetimeStampsEarned: number lastStampUpdate: string (date-time) createdAt: string (date-time) updatedAt: string (date-time) membershipManaged: boolean — Included within member lookup pass wrappers memberMembershipId: string — Managing membership _id, when included in a member lookup pass wrapper passIssued: boolean membershipGrant: object — Membership assignment result, when requested membershipGranted: boolean membershipGrantFailed: boolean membershipGrantError: string message: string