# list.member_added

A Patient was added to a List.

## Payload schema

- `object`
  - `api_version` (`any`)
  - `context` (`object`) - Present only when `source` is `api`. Identifies the acting project and API key.
    - `developer_platform_api_key_id` (`string | null`) - format: `uuid`
    - `developer_platform_project_id` (`string | null`) - format: `uuid`
  - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
  - `data` (`object`)
    - `object` (`object`)
      - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
      - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - `links` (`object`) - URLs to related resources.
        - `list` (`string`) - format: `uri`; The full URL of a related resource.
        - `patient` (`string | null`) - format: `uri`; The full URL of a related resource.
        - `self` (`string`) - format: `uri`; The full URL of a related resource.
      - `list` (`any`) - The list that contains this member.
      - `member` (`object | null`) - The ListMember and its resource. Null when the resource has been removed.
        - `patient` (`object`)
          - `address_line_1` (`string | null`) - The primary address line of the Patient.
          - `address_line_2` (`string | null`) - The secondary address line of the Patient.
          - `city` (`string | null`) - The city in the Patient's postal address.
          - `country_code` (`string | null`) - The ISO 3166-1 alpha-2 country code for the postal address, such as `GB` for the United Kingdom.
          - `county` (`string | null`) - The county or region in the Patient's postal address.
          - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
          - `creation_source` (`string | null`) - How the Patient was created. `api` means the record was created through the Developer Platform. Read-only.
          - `date_of_birth` (`string | null`) - format: `date`; The date of birth of the patient, in ISO 8601 format (YYYY-MM-DD).
          - `display_name` (`string | null`) - The formatted display name of the patient, including their title when recorded.
          - `email` (`string | null`) - format: `email`; The email address of the patient, when recorded.
          - `first_name` (`string | null`) - The first name of the patient.
          - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
          - `is_opted_out_of_sms` (`boolean`) - Whether the Patient has opted out of SMS messages.
          - `last_name` (`string | null`) - The last name of the patient.
          - `mobile` (`string | null`) - The national mobile number without its country calling code.
          - `mobile_country_dial_code` (`string | null`) - The ISO 3166-1 alpha-2 country code used to derive the mobile calling code.
          - `nhs_number` (`string | null`) - The 10-digit NHS number of the patient, without formatting.
          - `object` (`any`) - Discriminator value emitted at `object`.
          - `phone` (`string | null`) - The national phone number without its country calling code.
          - `phone_country_dial_code` (`string | null`) - The ISO 3166-1 alpha-2 country code used to derive the phone calling code.
          - `phone_number` (`string | null`) - The Patient's preferred contact number, formatted for display and compatible with E.164.
          - `postcode` (`string | null`) - The postal code of the Patient.
          - `sex` (`string | null`) - enum: `female`, `male`, `other`, `null`; The Patient's recorded sex.
          - `title` (`string | null`) - The personal title of the patient, when recorded.
          - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
        - `type` (`string`) - enum: `patient`; The kind of member. Additional values may be added later.
      - `object` (`any`) - Discriminator value emitted at `object`.
      - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
  - `developer_platform_project_id` (`string | null`) - format: `uuid`; The project ID whose credential caused the change. Null for `dashboard` events.
  - `id` (`string`) - Event identifier prefixed with `evt_`.
  - `livemode` (`boolean`) - `false` for test-event deliveries.
  - `object` (`any`)
  - `source` (`string`) - enum: `api`, `dashboard`; Origin of the change. `api` means a Developer Platform mutation; `dashboard` means a Carebit-initiated change.
  - `type` (`any`)

### Example payload

```json
{
  "id": "evt_00000000-0000-4000-8000-000000000012",
  "object": "event",
  "api_version": "v1",
  "created_at": "2026-01-01T09:00:00Z",
  "data": {
    "object": {
      "id": "00000000-0000-4000-8000-000000000010",
      "object": "list_member",
      "created_at": "2026-01-01T09:00:00Z",
      "links": {
        "list": "https://api.carebit.co/v1/lists/00000000-0000-4000-8000-000000000011",
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004",
        "self": "https://api.carebit.co/v1/lists/00000000-0000-4000-8000-000000000011/members/00000000-0000-4000-8000-000000000010"
      },
      "list": {
        "id": "00000000-0000-4000-8000-000000000011",
        "object": "list",
        "clinician_id": "00000000-0000-4000-8000-000000000002",
        "color_hex": "#28a745",
        "created_at": "2026-01-01T09:00:00Z",
        "links": {
          "clinician": "https://api.carebit.co/v1/clinicians/00000000-0000-4000-8000-000000000002",
          "members": "https://api.carebit.co/v1/lists/00000000-0000-4000-8000-000000000011/members",
          "self": "https://api.carebit.co/v1/lists/00000000-0000-4000-8000-000000000011"
        },
        "name": "Test list",
        "notes": "Some notes",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "member": {
        "patient": {
          "id": "00000000-0000-4000-8000-000000000004",
          "object": "patient",
          "address_line_1": "1 Test Street",
          "address_line_2": null,
          "city": "Test City",
          "country_code": "GB",
          "county": "Testshire",
          "created_at": "2026-01-01T09:00:00Z",
          "creation_source": "api",
          "date_of_birth": "1970-01-01",
          "display_name": "Ms Test Patient",
          "email": "test.patient@example.invalid",
          "first_name": "Test",
          "is_opted_out_of_sms": false,
          "last_name": "Patient",
          "mobile": "7700900123",
          "mobile_country_dial_code": "GB",
          "nhs_number": "9990000000",
          "phone": "1234567890",
          "phone_country_dial_code": "GB",
          "phone_number": "+441234567890",
          "postcode": "TE1 1ST",
          "sex": "female",
          "title": "Ms",
          "updated_at": "2026-01-01T09:00:00Z"
        },
        "type": "patient"
      },
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "list.member_added"
}
```