El objeto de miembro

Atributos

  • member_id string obligatorio

    Identificador único del miembro.

  • facility_id string uno u otroIndica el tipo de identificador de instalación configurado para tu integración: usa facility_id en las integraciones de vinculación directa o linking_identifier en las integraciones con identificador de vinculación. No envíes ambos; la API usa el tipo de identificador configurado para tu cuenta de socio e ignora el otro. Más información

    Identificador único de la instalación en el Performance Hub.

  • linking_identifier string uno u otroIndica el tipo de identificador de instalación configurado para tu integración: usa facility_id en las integraciones de vinculación directa o linking_identifier en las integraciones con identificador de vinculación. No envíes ambos; la API usa el tipo de identificador configurado para tu cuenta de socio e ignora el otro. Más información

    Valor del identificador único que el socio usa para cada ubicación (por ejemplo, "Branch ID", "Location Code" o "Store Number"). Más información

  • first_name string obligatorio

    Nombre del miembro.

  • last_name string obligatorio

    Apellido del miembro.

  • email string opcional

    Dirección de correo electrónico.

  • mobile_phone string opcional

    Número de teléfono móvil en formato E.123 (por ejemplo, "+1 415 555 2671").

  • address object opcional

    Objeto de dirección física con las siguientes propiedades:

    • address_line_1 (string): dirección principal
    • address_line_2 (string, opcional): línea de dirección secundaria
    • city (string): nombre de la ciudad
    • state (string): código del estado o la provincia
    • postal_code (string): código postal
    • country (string): código de país ISO 3166-1 alfa-2 (por ejemplo, "AU" o "US")
    • country_name (string, opcional): nombre completo del país
  • date_of_birth string opcional

    Fecha de nacimiento en formato YYYY-MM-DD.

  • gender string opcional

    Uno de estos valores: male, female, non_binary, prefer_not_to_say o unknown.

  • type string opcional

    Tipo de miembro (por ejemplo, staff, member o prospect).

  • tags array opcional

    Cadenas o textos auxiliares para clasificar e identificar rápidamente a miembros específicos (por ejemplo, ["vip", "personal-training", "student"]).

  • membership_status string opcional

    Estado actual de la membresía (por ejemplo, active, expired u on_hold).

  • membership_plans array opcional

    Matriz de planes de membresía asociados al miembro.

  • profile_picture string opcional

    Foto de perfil codificada en Base64 (opcional).

  • created string opcional

    Marca de tiempo ISO 8601 del momento en que se creó el miembro.

  • updated string opcional

    Marca de tiempo ISO 8601 de la última actualización del miembro.

  • access_time_windows array opcional

    Instantánea completa, perteneciente a la fuente, de las Access Time Windows absolutas o semanales recurrentes. Omite el campo para no modificar la instantánea; envía una matriz vacía con una revisión más reciente para revocarla. Consulta Access Time Windows para conocer las formas, la validación, la asignación de ámbitos y la semántica de reemplazo.

  • access_time_windows_revision integer obligatorio con access_time_windows

    Entero no negativo, monótonamente creciente y seguro para JSON, correspondiente a la secuencia de este miembro y esta fuente. Es obligatorio siempre que access_time_windows esté presente.

El objeto de miembro

{
  "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
    }
  ]
}