Skip to main content

Update a member

PUT /members/{id}

Requires the members:write permission.

Authorization

X-API-Key required

Parameters

NameLocationTypeRequired
idpathstringYes

Request Body

FieldTypeRequiredDescription
titleMr, Ms, Mrs, Miss, Sir, Madam, Dr, RevNoOptional member title or honorific.
namestringNoUpdated member full name.
firstNamestringNoUpdated member first name.
lastNamestringNoUpdated member last name.
emailstring (email)NoUpdated member email address.
addressobjectNo
contactPreferencesobjectNo
memberIdstringNoUnique member identifier. Must not contain spaces.
memberSincestring (date-time)NoUpdated member joined date.
typeMember, VisitorNoUpdated member category.
statusactive, inactiveNoUpdated member account status.
locationstringNoMember location or branch.
phonestringNoMember phone number.
dateOfBirthstring (date)NoMember date of birth.
gendermale, female, other, prefer_not_to_sayNoMember gender.
notesstringNoInternal member notes.
flaggedbooleanNoWhether the member is flagged for staff attention.
flagNotestringNoOptional note shown when the member is flagged.
customFieldsobjectNoUpdated organisation-defined custom field values keyed by custom field key. Use first-party fields such as phone, dateOfBirth, gender, and notes at the top level.

Request Examples

curl -X PUT "https://api.remypass.com/api/v1/public/members/507f1f77bcf86cd799439011" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Mr",
  "name": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "user@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
  }
}'

Use Case Examples

Update member

curl -X PUT https://api.remypass.com/api/v1/public/members/507f1f77bcf86cd799439011 \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Prof",
"name": "Prof. John Smith",
"phone": "+447700900124",
"dateOfBirth": "1988-09-12",
"gender": "male",
"notes": "Updated contact preference",
"memberId": "MEM001",
"status": "active",
"customFields": {
"department": "Research",
"position": "Senior Researcher"
}
}'

Responses

StatusDescription
200Member updated.
400Bad request. The top-level message explains what is invalid and, where applicable, the errors array contains structured field details.
401Missing or invalid API key.
403The caller is not allowed to access this resource.
404Resource not found.
500Server error.

200 Response Example

{
"success": true,
"message": "string",
"data": {
"_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": 1,
"createdAt": "2026-01-01T12:00:00.000Z",
"updatedAt": "2026-01-01T12:00:00.000Z"
}
}

Response Fields

FieldTypeAttributes
successboolean
messagestring
dataobject
Show child attributes
  • _id: string
  • title: Mr, Ms, Mrs, Miss, Sir, Madam, Dr, Rev
  • name: string
  • firstName: string
  • lastName: string
  • email: string (email)
  • address: object
    Show child attributes
    • addressLine1: string
    • addressLine2: string
    • city: string
    • region: string
    • postalCode: string
    • country: string
  • contactPreferences: object
    Show child attributes
    • email: boolean
    • post: boolean
    • phone: boolean
  • memberId: string
  • memberSince: string (date-time)
  • type: Member, Visitor
  • status: active, inactive
  • location: string
  • phone: string
  • dateOfBirth: string (date)
  • gender: male, female, other, prefer_not_to_say
  • notes: string
  • flagged: boolean
  • flagNote: string
  • customFields: object
  • passes: integer
  • createdAt: string (date-time)
  • updatedAt: string (date-time)