v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Drop-In

Convert Drop-In to Lead

Convert a Drop-In to a Lead. Any data not sent in the request will use the Drop-In's existing data.

post/dropins/{dropin_id}/convert

Path parameters

dropin_idinteger required

Unique Drop In 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

Email address to associate with the Client profile of the converted Lead.

Response

Data about the converted Drop-In.

Example response

{
  "lead_data": {
    "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"
  }
}