会员对象

属性

  • member_id string 必填

    会员的唯一标识符。

  • facility_id string 二选一请提供为您的集成配置的设施标识符类型:直接关联集成使用 facility_id,关联标识符集成使用 linking_identifier。请勿同时发送两者;API 会使用为您的合作伙伴账户配置的标识符类型,并忽略另一个。了解详情

    Performance Hub 中设施的唯一标识符。

  • linking_identifier string 二选一请提供为您的集成配置的设施标识符类型:直接关联集成使用 facility_id,关联标识符集成使用 linking_identifier。请勿同时发送两者;API 会使用为您的合作伙伴账户配置的标识符类型,并忽略另一个。了解详情

    合作伙伴为每个位置使用的唯一标识符值(例如“Branch ID”“Location Code”“Store Number”)。了解详情

  • first_name string 必填

    会员的名字。

  • last_name string 必填

    会员的姓氏。

  • email string 可选

    电子邮件地址。

  • mobile_phone string 可选

    E.123 格式的手机号码(例如 "+1 415 555 2671")。

  • address object 可选

    实际地址对象,包含以下属性:

    • address_line_1(string):主要街道地址
    • address_line_2(string,可选):地址第二行
    • city(string):城市名称
    • state(string):州/省代码
    • postal_code(string):邮政编码
    • country(string):ISO 3166-1 alpha-2 国家/地区代码(例如“AU”“US”)
    • country_name(string,可选):国家/地区全称
  • date_of_birth string 可选

    YYYY-MM-DD 格式的出生日期。

  • gender string 可选

    取值为 male、female、non_binary、prefer_not_to_say 或 unknown 之一。

  • type string 可选

    会员类型(例如 staff、member、prospect)。

  • tags array 可选

    用于对特定会员进行分类和识别的快捷辅助字符串或文本(例如 ["vip", "personal-training", "student"])。

  • membership_status string 可选

    当前会员状态(例如 active、expired、on_hold)。

  • membership_plans array 可选

    与会员关联的会员计划数组。

  • profile_picture string 可选

    Base64 编码的个人资料照片(可选)。

  • created string 可选

    会员创建时间的 ISO 8601 时间戳。

  • updated string 可选

    会员上次更新时间的 ISO 8601 时间戳。

  • access_time_windows array 可选

    由源拥有的绝对和/或每周重复 Access Time Windows 的完整快照。省略该字段将保持快照不变;使用更新的修订号发送空数组可将其撤销。有关结构、验证、范围映射和替换语义,请参阅 Access Time Windows。

  • access_time_windows_revision integer 提供 access_time_windows 时必填

    此会员/源序列的单调递增、非负且 JSON 安全的整数。只要存在 access_time_windows,此字段即为必填。

会员对象

{
  "member_id": "member_11111",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  // "linking_identifier": "branch_downtown",  // If using linking identifier
  "first_name": "John",
  "last_name": "Smith",
  "email": "john.smith@example.com",
  "mobile_phone": "+61 412 345 678",
  "date_of_birth": "1985-06-15",
  "gender": "male",
  "type": "member",
  "tags": ["vip", "personal-training"],
  "profile_picture": "/9j/4AAQSkZJRgABAQAAAQ...",
  "membership_status": "current",
  "created": "2024-01-15T10:30:00Z",
  "updated": "2024-01-20T14:45:00Z",
  "access_time_windows_revision": 1842,
  "access_time_windows": [
    {
      "external_id": "access-4b1782",
      "kind": "absolute",
      "from": 1792053000,
      "to": 1792058400,
      "timezone": "Australia/Perth",
      "scope_key": "after_hours_entry",
      "label": "Temporary site access"
    }
  ],
  "address": {
    "address_line_1": "456 Bourke Street",
    "address_line_2": "Apt 12",
    "city": "Melbourne",
    "state": "VIC",
    "postal_code": "3000",
    "country": "AU",
    "country_name": "Australia"
  },
  "membership_plans": [
    {
      "membership_plan_id": "plan_99999",
      "name": "Unlimited Monthly",
      "start_date": "2024-01-01T00:00:00Z",
      "status": "current",
      "is_current": true,
      "end_date": null
    }
  ]
}