Sign in
Memberships

Add a member to a membership

Adds an existing Customer to the given Membership as an additional member. The customer is identified by their customer_id.

post/customers/memberships/{membershipId}/members

Request body

customer_idstring uuid required

The Customer to add as a member of the membership. The customer must belong to the same brand as the membership; the platform rejects cross-brand additions with 422 Unprocessable Entity.

Response

The MembershipMember was successfully retrieved or updated.

Example response

{
  "data": {
    "customer": {
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "last_check_in": {
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "ext-cust-789012"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.