Members

The members resource represents contacts who are members.

Member object

{
  "id": "0198ae4e-0912-7009-a834-2a54c7069cf5",
  "tenant": "01988bb8-1cfb-7c87-9326-93op0349288e",
  "contact": "0198a3d1-cc50-7acf-bf60-oecn2sa0kh8c",
  "member_identifier": "10229",
  "status": "01988bb8-2077-7be6-8a26-38d1c7991e87",
  "date_start": "2022-12-06",
  "date_end": null,
  "staff_advisor": "0198a8c5-cb14-7f37-885b-a4g5sy7zl4kf",
  "reachout_enabled": false,
  "reachout_duration_days": 0,
  "notes": null,
  "meta": null,
  "archived_at": null,
  "created_at": "2025-08-15 15:16:46",
  "updated_at": null
}

Fields

• id
  required readonly string
  Unique ID of the record.
• tenant
  required readonly string
  Unique ID of the tenant.
• contact
  required string
  Unique ID of the contact.
• member_identifier
  nullable string
  Unique identifier for the member within the tenant.
• status
  nullable string
  Unique ID of the status.
• date_start
  required string
  UTC timestamp of when the member started.
• date_end
  nullable string
  UTC timestamp of when the member ended.
• staff_advisor
  nullable string
  Unique ID of the staff acting as advisor to this member.
• reachout_enabled
  boolean
  Whether reachout is enabled for this member. The default value is false.
• reachout_duration_days
  nullable integer
  The number of days to elapse between the last member attendance and reachout before reachout is due as shown in the reachout report. If reachout_enabled is true and the staff advisor's email address corresponds to a valid Bloom user, a reachout notification will be created for the staff advisor when reachout is due.
• notes
  nullable string
  Notes about the member.
• meta
  nullable object
  Additional metadata about the staff.
• archived_at
  nullable string
  UTC timestamp of when the record was archived.
• created_at
  required readonly string
  UTC timestamp of when the record was created.
• updated_at
  nullable readonly string
  UTC timestamp of when the record was last updated.

Create a member

POST /tenants/{tenantId}/members

The request body must include a member object.

Required permissions

members:create contacts:read staff:read

Response

List members

GET /tenants/{tenantId}/members

Required permissions

members:read contacts:read staff:read

Response

Read a member

GET /tenants/{tenantId}/members/{id}

Required permissions

members:read contacts:read staff:read

Response

Update a member

PATCH /tenants/{tenantId}/members/{id}

The request body must include parts of a member object.

Required permissions

members:update contacts:read staff:read

Response

Delete a member

DELETE /tenants/{tenantId}/members/{id}

Required permissions

members:delete

Response