Support Member

A support member is an organization member on the support tier. They can do supporting tasks like scheduling appointments, submitting insurance claims, and more.

The support member model

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the support member.

  • Name
    object
    Type
    string
    Description

    Always 'support'.

  • Name
    first_name
    Type
    string
    Description

    Support member's first name.

  • Name
    middle_name
    Type
    string
    Description

    Support member's middle name.

  • Name
    last_name
    Type
    string
    Description

    Support member's last name.

  • Name
    preferred_name
    Type
    string
    Description

    Support member's preferred name.

  • Name
    admin
    Type
    string
    Description

    Whether the upport member is a global admin, local admin, or not an admin.

    Possible values:
    global_admin
    local_admin
    not_admin
  • Name
    email
    Type
    string
    Description

    Support member's email address.

  • Name
    phone
    Type
    string
    Description

    Support member's phone number.

  • Name
    medical_centers
    Type
    array of strings
    Description

    Medical centers that the support member belongs to.

  • Name
    specialization
    Type
    string
    Description

    What specialization (e.g. Biller, Administrator, etc.) the member belongs to. Must be one of the specializations set for support members in the specializations object.

  • Name
    timezone
    Type
    string
    Description

    Support member's timezone.

  • Name
    status_history
    Type
    array of objects
    Description
    Status history of the support.
  • Name
    custom_data
    Type
    array of objects
    Description
    Custom field and values added to the support member object
  • Name
    created_by
    Type
    string
    Description

    Creator of the support member.

  • Name
    created_at
    Type
    date-time
    Description

    Timestamp (in ISO 8601 format) of when the member was created.

  • Name
    last_updated_at
    Type
    date-time
    Description

    Timestamp (in ISO 8601 format) of when the member was last updated.

Response

{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "support",
    "first_name": "Tom",
    "middle_name": "",
    "last_name": "Seltz",
    "preferred_name": null,
    "admin": "not_admin",
    "email": "tom@demo.com",
    "phone": "(860)409-4300",
    "medical_centers": [
        "mctr_XbvBirnEb1Mli1OLwqnM"
    ],
    "specialization": "spec_kLbviBrnEb1Mli1OLwqnM",
    "timezone": "America/New_York",
    "status_history": [{
        "status": "active",
        "changed_by": "user_xeDpGyt67wTor93qKtS7",
        "changed_at": "2024-04-10T13:20:21.724Z"
    }],
    "custom_data": [{
        "id": "cdta_ZR6ioEDFTnKLFn62oknLF",
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "value": "Routine Care"
    }],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}
POST/v2/supports

Create a support member

Creates a new support member.

Required attributes

  • Name
    first_name
    Type
    string
    Description

    Support member's first name.

  • Name
    last_name
    Type
    string
    Description

    Support member's last name.

  • Name
    admin
    Type
    string
    Description

    Whether the support member is a global admin, local admin, or not an admin.

    Possible values:
    global_admin
    local_admin
    not_admin
  • Name
    email
    Type
    string
    Description

    Support member's email address.

  • Name
    specialization
    Type
    string
    Description

    What specialization (e.g. Biller, Administrator, etc.) the support member belongs to. Must be one of the specializations set for supports in the specializations object.

  • Name
    timezone
    Type
    string
    Description

    Support member's timezone.

  • Name
    status
    Type
    string
    Description

    Status of the support member.

    Possible values:
    active
    suspended
    archived
  • Name
    custom_data
    Type
    array of objects
    Description
    Custom field and values added to the support member object. Some fields may be required while others as optional.

Optional attributes

  • Name
    middle_name
    Type
    string
    Description

    Support member's middle name.

  • Name
    preferred_name
    Type
    string
    Description

    Support member's preferred name.

  • Name
    phone
    Type
    string
    Description

    Support member's phone number.

  • Name
    medical_centers
    Type
    array of strings
    Description

    Medical centers that the support member belongs to.

Response

{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "support",
    "first_name": "Tom",
    "middle_name": "",
    "last_name": "Seltz",
    "preferred_name": null,
    "admin": "not_admin",
    "email": "tom@demo.com",
    "phone": "(860)409-4300",
    "medical_centers": [
        "mctr_XbvBirnEb1Mli1OLwqnM"
    ],
    "specialization": "spec_kLbviBrnEb1Mli1OLwqnM",
    "timezone": "America/New_York",
    "status_history": [{
        "status": "active",
        "changed_by": "user_xeDpGyt67wTor93qKtS7",
        "changed_at": "2024-04-10T13:20:21.724Z"
    }],
    "custom_data": [{
        "id": "cdta_ZR6ioEDFTnKLFn62oknLF",
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "value": "Routine Care"
    }],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}
GET/v2/supports/:id

Retrieve a support member

Retrieves the specified support member.

Response

{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "support",
    "first_name": "Tom",
    "middle_name": "",
    "last_name": "Seltz",
    "preferred_name": null,
    "admin": "not_admin",
    "email": "tom@demo.com",
    "phone": "(860)409-4300",
    "medical_centers": [
        "mctr_XbvBirnEb1Mli1OLwqnM"
    ],
    "specialization": "spec_kLbviBrnEb1Mli1OLwqnM",
    "timezone": "America/New_York",
    "status_history": [{
        "status": "active",
        "changed_by": "user_xeDpGyt67wTor93qKtS7",
        "changed_at": "2024-04-10T13:20:21.724Z"
    }],
    "custom_data": [{
        "id": "cdta_ZR6ioEDFTnKLFn62oknLF",
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "value": "Routine Care"
    }],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}
POST/v2/supports/:id

Update a support member

Updates the specified support member object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

    Optional attributes

    • Name
      first_name
      Type
      string
      Description

      Support member's first name.

    • Name
      middle_name
      Type
      string
      Description

      Support member's middle name.

    • Name
      last_name
      Type
      string
      Description

      Support member's last name.

    • Name
      preferred_name
      Type
      string
      Description

      Support member's preferred name.

    • Name
      admin
      Type
      string
      Description

      Whether the support member is a global admin, local admin, or not an admin.

      Possible values:
      global_admin
      local_admin
      not_admin
    • Name
      phone
      Type
      string
      Description

      Support member's phone number.

    • Name
      medical_centers
      Type
      array of strings
      Description

      Medical centers that the support member belongs to.

    • Name
      specialization
      Type
      string
      Description

      What specialization (e.g. Biller, Administrator, etc.) the support member belongs to. Must be one of the specializations set for supports in the specializations object.

    • Name
      timezone
      Type
      string
      Description

      Support member's timezone.

    • Name
      status
      Type
      string
      Description

      Status of the support member.

      Possible values:
      active
      suspended
      archived
    • Name
      custom_data
      Type
      array of objects
      Description

      Custom field and values added to the support member object.

    Response

    {
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "support",
    "first_name": "Tom",
    "middle_name": "",
    "last_name": "Seltz",
    "preferred_name": null,
    "admin": "not_admin",
    "email": "tom@demo.com",
    "phone": "(860)409-4300",
    "medical_centers": [
        "mctr_XbvBirnEb1Mli1OLwqnM"
    ],
    "specialization": "spec_kLbviBrnEb1Mli1OLwqnM",
    "timezone": "America/New_York",
    "status_history": [{
        "status": "active",
        "changed_by": "user_xeDpGyt67wTor93qKtS7",
        "changed_at": "2024-04-10T13:20:21.724Z"
    }],
    "custom_data": [{
        "id": "cdta_ZR6ioEDFTnKLFn62oknLF",
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "value": "Routine Care"
    }],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}
    GET/v2/supports

    List all support members

    Returns a list of all support members.

    Response

    {
  "object": "list",
  "data": [{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "support",
    "first_name": "Tom",
    "middle_name": "",
    "last_name": "Seltz",
    "preferred_name": null,
    "admin": "not_admin",
    "email": "tom@demo.com",
    "phone": "(860)409-4300",
    "medical_centers": [
        "mctr_XbvBirnEb1Mli1OLwqnM"
    ],
    "specialization": "spec_kLbviBrnEb1Mli1OLwqnM",
    "timezone": "America/New_York",
    "status_history": [{
        "status": "active",
        "changed_by": "user_xeDpGyt67wTor93qKtS7",
        "changed_at": "2024-04-10T13:20:21.724Z"
    }],
    "custom_data": [{
        "id": "cdta_ZR6ioEDFTnKLFn62oknLF",
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "value": "Routine Care"
    }],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}],
}