Update member contact details using JSON Patch

PATCH /api/members/{memberId}/contact-details

• Products: Operator (FOH), Consumer (CONSUMER) (any one of these products, not all)
• Features: Online Bookings (ONLINEBOOK), Online Joining (ONLINEJOIN), Front of House Generic Access (FOHGENERIC) (any one of these features, not all)

Overview

Updates a member's email addresses and telephone numbers using a JSON Patch document (RFC 6902).

This is a genuine partial update. Your operations are applied to the member's current contact details, and the result is then validated and saved — so anything you do not name in an operation keeps its existing value. There is no PUT equivalent; this endpoint is the only way to change these fields.

A member has exactly five fixed contact slots, not a growable list:

Because the slots are fixed, add and replace behave identically — both overwrite the slot. add never creates a third email or a fourth phone number.

Three rules cause most rejections:

1. Only one primary at a time. At most one of email1/email2 may end up primary, and at most one of telephone1/telephone2/mobile. The check runs on the merged document, so setting a new primary without clearing the old one in the same request fails with 400.
2. Clearing a value requires the slot to be non-primary. Blanking an email or a number while its isPrimary is true is rejected. Set isPrimary to false in the same patch document.
3. A home email is mandatory for most members. Blanking /email1/emailAddress is rejected unless the member is under the tenant's configured age for online accounts, or /inheritPrimaryMembersEmail is true.

Linked members are permitted — a token issued for a member linked to {memberId} may call this endpoint.

Endpoint

PATCH {base_url}/api/members/{memberId}/contact-details

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Request body

The body is a JSON array of patch operations, applied in order.

Sample request

curl -X PATCH '{base_url}/api/members/{memberId}/contact-details' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "op": "replace",
    "path": "/email1/emailAddress",
    "value": "new.address@example.com"
  },
  {
    "op": "replace",
    "path": "/mobile/number",
    "value": "07123456789"
  },
  {
    "op": "replace",
    "path": "/mobile/isPrimary",
    "value": true
  },
  {
    "op": "replace",
    "path": "/telephone1/isPrimary",
    "value": false
  }
]'

Errors

A successful call returns 204 No Content. Validation runs on the merged document, so an error message can name a field you did not patch.

This page as markdown · All pages · llms.txt