v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Client

Suspend Client

Suspend a Client with the provided ID.

put/clients/{client_id}/suspend

Path parameters

client_idinteger required

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Response

Returns if the Suspension was a success and the Client's data

is_successboolean

Determines if the action was successful

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user.

Example response

{
  "ClientResponse": {
    "id": 1234567891234567,
    "client_status_id": 1234567891234567,
    "location_id": 1234567891234567,
    "default_program_id": 1234567891234567,
    "date_of_birth": "2014-12-31",
    "gender_id": 1234567891234567,
    "state_id": 1234567891234567,
    "country_id": 1234567891234567,
    "timezone_id": 1234567891234567,
    "weight": 0.1,
    "group": {
      "group_id": 1234567891234567,
      "group_role_id": 1234567891234567,
      "other_group_participants": [
        {
          "group_participant_client_id": 1234567891234567,
          "group_role_id": 1234567891234567
        }
      ]
    },
    "created": {
      "created_by_id": 1234567891234567,
      "created_on_datetime": "2014-12-31T23:59:59.938Z"
    },
    "updated": {
      "updated_by_id": 1234567891234567,
      "updated_on_datetime": "2014-12-31T23:59:59.938Z"
    },
    "status_history": [
      {
        "from_status_id": 1234567891234567,
        "to_status_id": 1234567891234567,
        "status_change_datetime": "2014-12-31T23:59:59.938Z"
      }
    ],
    "last_attendance": "2014-12-31T23:59:59.938Z",
    "member_since": "2014-12-31",
    "last_contacted": "2014-12-31",
    "retain_snooze_until_date": "2014-12-31",
    "lead_id": 1234567891234567,
    "lead_source_id": 1234567891234567,
    "referring_user_id": 1234567891234567,
    "roles": [
      {
        "id": 1234567891234567
      }
    ],
    "available_programs": [
      {
        "program_id": 1234567891234567
      }
    ],
    "client_owner_id": 1234567891234567,
    "last_class_sign_in": "2014-12-31T23:59:59.938Z",
    "last_booking_sign_in": "2014-12-31T23:59:59.938Z",
    "current_weekstreak_updatedon": "2014-12-31T23:59:59.938Z",
    "next_class_reservation": "2014-12-31T23:59:59.938Z",
    "next_appointment_booking": "2014-12-31T23:59:59.938Z",
    "coach_services": [
      {
        "id": 1234567891234567,
        "service_icon_id": 1234567891234567,
        "durations": [
          {
            "id": 1234567891234567
          }
        ],
        "cancellation_policy": {
          "cancellation_unit_of_time_id": 1234567891234567,
          "cancellation_fee": 0.1,
          "cancellation_fee_tax_rate_id": 1234567891234567
        },
        "no_show_policy": {
          "no_show_fee": 0.1,
          "no_show_fee_tax_rate_id": 1234567891234567
        },
        "location_providers": [
          {
            "id": 1234567891234567,
            "location_id": 1234567891234567,
            "providers": [
              {
                "provider_id": 1234567891234567
              }
            ]
          }
        ],
        "bookings_open_time_window_unit_of_time_id": 1234567891234567,
        "bookings_close_time_window_unit_of_time_id": 1234567891234567,
        "waivers": [
          {
            "waiver_id": 1234567891234567
          }
        ],
        "created": {
          "created_by_id": 1234567891234567,
          "created_on_datetime": "2014-12-31T23:59:59.938Z"
        },
        "updated": {
          "updated_by_id": 1234567891234567,
          "updated_on_datetime": "2014-12-31T23:59:59.938Z"
        }
      }
    ],
    "coach_programs": [
      {
        "program_id": 1234567891234567
      }
    ],
    "coach_locations": [
      {
        "location_id": 1234567891234567
      }
    ]
  }
}