v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Lead Group

Convert Lead from Dependent

Convert a dependent Lead to a full group member.

put/leads/{lead_id}/convert-from-dependent

Path parameters

lead_idinteger required

Unique Lead ID.

Headers

x-api-keystring required

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

Request body

emailstring

Response

Lead data, if conversion was successful.

is_successboolean

Indicates if the action was successful.

Example response

{
  "lead_response": {
    "id": 1234567891234567,
    "lead_status_id": 1234567891234567,
    "location_id": 1234567891234567,
    "date_of_birth": "2014-12-31",
    "lead_group": {
      "group_id": 1234567891234567,
      "group_role_id": 1234567891234567,
      "other_group_participants": [
        {
          "group_participant_lead_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"
    },
    "last_contact_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"
      }
    ],
    "lead_source_id": 1234567891234567,
    "referred_by_user_id": 1234567891234567,
    "location_timezone_id": 1234567891234567,
    "created_from_source_id": 1234567891234567,
    "lead_owner_id": 1234567891234567,
    "last_class_sign_in": "2014-12-31T23:59:59.938Z",
    "last_booking_sign_in": "2014-12-31T23:59:59.938Z",
    "next_class_reservation": "2014-12-31T23:59:59.938Z",
    "next_appointment_booking": "2014-12-31T23:59:59.938Z"
  }
}