v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Lead

Update Lead

Update a Lead record given the Lead identifier and Lead data.

put/leads/{lead_id}

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

first_namestring

Lead's firstname

last_namestring

Lead's name

emailstring

Lead's Email

lead_status_idinteger

Lead's Status (Identifier)

location_idinteger

Lead's Location (Identifier)

gender_idinteger

Lead's Gender (Identifier)

phone_numberstring

Lead's Phone Number

date_of_birthstring date

Lead's Date of Birth

street_address1string

Lead's Address 1

street_address2string

Lead's Address 2

citystring

Lead's City

state_idinteger

Lead's State (Identifier)

provincestring

Lead's Province

zipcodestring

Lead's Zipcode

country_idinteger

Lead's Country (Identifier)

notesstring

Notes about the Lead

emergency_contact_namestring

Lead's Emergency Contact Name

emergency_contact_phonestring

Lead's Emergency Contact Phone Number

lead_source_idinteger

Lead's Source (Identifier)

referred_by_from_webstring

Who referred the Lead on Web (free text).

referred_by_user_idinteger

User who referred the Lead (Identifier)

is_email_subscribedstring

Indicates if the Lead wants to subscribe to Email or not.

is_sms_subscribedstring

lead_owner_idinteger

Example request

{
  "lead_status_id": 1234567891234567,
  "location_id": 1234567891234567,
  "date_of_birth": "2014-12-31",
  "lead_source_id": 1234567891234567,
  "referred_by_user_id": 1234567891234567,
  "lead_owner_id": 1234567891234567
}

Response

Updated Lead record.

idinteger

Unique Lead ID.

first_namestring

Lead's first name.

last_namestring

Lead's last name.

emailstring

Lead's email address.

lead_status_idinteger

Lead's status ID.

lead_statusstring

Lead's status label.

location_idinteger

Lead's default location ID.

locationstring

Lead's default location.

gender_idinteger

Lead's gender ID.

genderstring

Lead's gender.

phone_numberstring

Lead's phone number.

date_of_birthstring date

Lead's date of birth.

street_address1string

Lead's street address (line 1).

street_address2string

Lead's street address (line 2).

citystring

Lead's city.

state_idinteger

Lead's state ID.

statestring

Lead's state.

provincestring

Lead's province, if applicable.

zipcodestring

Lead's ZIP code.

country_idinteger

Lead's country ID.

countrystring

Lead's country.

tagsstring[]

Lead's tags as a text list.

notesstring

Lead's notes.

last_contact_datetimestring date-time

Datetime on which the Lead was last contacted.

is_converted_to_clientboolean

Indicates if the Lead has been converted to a Client.

emergency_contact_namestring

Name of the Lead's emergency contact.

emergency_contact_phonestring

Phone number of the Lead's emergency contact.

lead_source_idinteger

Lead's source ID.

lead_sourcestring

Lead's source.

referred_by_from_webstring

Who referred the Lead on the Web (free text).

referred_by_user_idinteger

Unique ID of the user who referred the Lead.

referred_by_user_namestring

Name of the use who referred the Lead.

is_email_subscribedboolean

Indicates if the Lead is subscribed to email communication.

is_sms_subscribedboolean

Indicates if the Lead is subscribed to SMS communication.

location_timezone_idinteger

ID of the Lead's default location time zone.

location_time_zonestring

Timezone of the Lead's location.

created_from_source_idinteger

The ID of the source from which the Lead was created.

created_from_sourcestring

The source from which the Lead was created.

profile_photo_urlstring

Lead's profile photo URL.

lead_owner_idinteger

Unique Client ID of the Employee assigned to the Lead.

lead_ownerstring

Name of the Employee assigned to the Lead.

total_class_sign_insinteger

Total number of Classes that the Lead has signed into.

total_booking_sign_insinteger

Total number of Appointment Bookings the Lead has signed into.

last_class_sign_instring date-time

Datetime of the last Class the Lead has signed into.

last_booking_sign_instring date-time

Datetime of the last Appointment Booking the Lead has signed into.

days_since_last_attendanceinteger

Number of days since the Lead last attended

is_activeboolean

Indicates if the lead is active.

next_class_reservationstring date-time

Date and time of next (soonest in the future) Reservation in the Status of “Reserved”

next_appointment_bookingstring date-time

Date and time of next (soonest in the future) Booking in the Status of “Reserved”

Example 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"
}