WOwodify
Bookings

Create Lead Booking

Books an appointment for a Lead.

post/appointments/bookings/leads/{lead_id}

Request

  • Base URL
    https://api.wodify.com/v1
  • URL
    https://api.wodify.com/v1/appointments/bookings/leads/{lead_id}
  • Auth
    none declared. Required headers: x-api-key

Path parameters

lead_idinteger required

Id of the Lead to book an appointment

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Automations → Integrations page.

Request body

location_idinteger required

Location Id

service_idinteger required

Service Id

provider_idinteger required

Provider Id

pay_rate_idinteger required

Identifies the pay rate associated to this provider

start_datestring date required

Booking Start Date in Customer's Time Zone

start_timestring time required

Booking Start Time in Customer's Time Zone

service_duration_idinteger required

Service Duration Id

Example request

{
  "location_id": 1234567891234567,
  "service_id": 1234567891234567,
  "provider_id": 1234567891234567,
  "pay_rate_id": 1234567891234567,
  "start_date": "2014-12-31",
  "start_time": "23:59:59",
  "service_duration_id": 1234567891234567
}

Response

Lead Booking

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. All methods should have, just like service actions: - an UserException with Abort Transaction = Yes, and a Log Error = No - an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

Example response

{
  "lead_appointment_booking": {
    "booking_id": 1234567891234567,
    "lead_id": 1234567891234567,
    "appointment_id": 1234567891234567,
    "utc_appointment_start_datetime": "2014-12-31T23:59:59.938Z",
    "utc_appointment_end_datetime": "2014-12-31T23:59:59.938Z",
    "local_appointment_start_datetime": "2014-12-31T23:59:59.938Z",
    "local_appointment_end_datetime": "2014-12-31T23:59:59.938Z",
    "location_id": 1234567891234567,
    "booking_status_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"
    },
    "membership_id": 1234567891234567,
    "cancelled": {
      "cancelled_by_id": 1234567891234567,
      "cancelled_on_datetime": "2014-12-31T23:59:59.938Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.