O objeto Member

Atributos

• member_id string obrigatório

  Identificador exclusivo do membro.

• facility_id string um ou outroInforme o tipo de identificador de instalação configurado para sua integração: use facility_id em integrações de vinculação direta ou linking_identifier em integrações com identificador de vinculação. Não envie os dois; a API usa o tipo de identificador configurado para sua conta de parceiro e ignora o outro. Saiba mais

  Identificador exclusivo da instalação no Performance Hub.

• linking_identifier string um ou outroInforme o tipo de identificador de instalação configurado para sua integração: use facility_id em integrações de vinculação direta ou linking_identifier em integrações com identificador de vinculação. Não envie os dois; a API usa o tipo de identificador configurado para sua conta de parceiro e ignora o outro. Saiba mais

  Valor do identificador exclusivo que o parceiro usa para cada local (por exemplo, "Branch ID", "Location Code", "Store Number"). Saiba mais

• first_name string obrigatório

  Nome do membro.

• last_name string obrigatório

  Sobrenome do membro.

• email string opcional

  Endereço de e-mail.

• mobile_phone string opcional

  Número de celular no formato E.123 (por exemplo, "+1 415 555 2671").

• address object opcional

  Objeto de endereço físico com as seguintes propriedades:

  • address_line_1 (string) - Endereço principal
  • address_line_2 (string, opcional) - Linha de endereço complementar
  • city (string) - Nome da cidade
  • state (string) - Código do estado/província
  • postal_code (string) - CEP/código postal
  • country (string) - Código de país ISO 3166-1 alfa-2 (por exemplo, "AU", "US")
  • country_name (string, opcional) - Nome completo do país

• date_of_birth string opcional

  Data de nascimento no formato YYYY-MM-DD.

• gender string opcional

  Um destes: male, female, non_binary, prefer_not_to_say ou unknown.

• type string opcional

  Tipo de membro (por exemplo, staff, member, prospect).

• tags array opcional

  Strings ou textos auxiliares rápidos para categorizar e identificar membros específicos (por exemplo, ["vip", "personal-training", "student"]).

• membership_status string opcional

  Status atual da associação (por exemplo, active, expired, on_hold).

• membership_plans array opcional

  Matriz de planos de associação vinculados ao membro.

• profile_picture string opcional

  Foto de perfil codificada em Base64 (opcional).

• created string opcional

  Carimbo de data/hora ISO 8601 de quando o membro foi criado.

• updated string opcional

  Carimbo de data/hora ISO 8601 da última atualização do membro.

• access_time_windows array opcional

  Snapshot completo, pertencente à origem, das Access Time Windows absolutas e/ou semanais recorrentes. Omita o campo para manter o snapshot inalterado; envie uma matriz vazia com uma revisão mais nova para revogá-lo. Consulte Access Time Windows para ver os formatos, a validação, o mapeamento de escopo e a semântica de substituição.

• access_time_windows_revision integer obrigatório com access_time_windows

  Inteiro não negativo, monotonicamente crescente e seguro para JSON, para este fluxo de membro/origem. Obrigatório sempre que access_time_windows estiver presente.

O objeto Member

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