action onsched_put_consumer_v1_appointments_id_book { label: "Book Appointment" description: "

Use this endpoint to Book an appointment. Only appointments with an \"IN\" status, Initial, can be booked. A valid appointment id is required. Use the appointment id returned from the initial POST /consumer/v1/appointments endpoint. Other pertinent fields can also be updated at the time of booking by including them in the post body. Note: If no name or email address was provided in the initial Post Appointment, it will be required in the post body.

\n

For more information: Appointments Overview

" provider: onsched method: PUT path: "/consumer/v1/appointments/{id}/book" encoding: json input: { type: "object" properties: { appointmentBookingFields: { type: "array" items: { type: "object" properties: { name: { type: "string" } value: { type: "string" } } additionalProperties: false } } customFields: { type: "object" properties: { field1: { type: "string" } field10: { type: "string" } field2: { type: "string" } field3: { type: "string" } field4: { type: "string" } field5: { type: "string" } field6: { type: "string" } field7: { type: "string" } field8: { type: "string" } field9: { type: "string" } } additionalProperties: false } customerBookingFields: { type: "array" items: { type: "object" additionalProperties: true } } customerMessage: { type: "string" } email: { type: "string" } groupSize: { type: "integer" format: "int32" } id: { type: "string" } name: { type: "string" } notes: { type: "string" } phone: { type: "string" } phoneExt: { type: "string" } phoneType: { type: "string" } } required: ["id"] additionalProperties: false } output: { type: "object" properties: { auditTrail: { type: "array" items: { type: "object" properties: { appointmentId: { type: "string" } id: { type: "string" } modificationType: { type: "string" } modifiedBy: { type: "string" } modifiedOn: { type: "string" } notesAfter: { type: "string" } notesBefore: { type: "string" } statusAfter: { type: "string" } statusBefore: { type: "string" } } additionalProperties: false } } bookedBy: { type: "string" } businessName: { type: "string" } calendarId: { type: "string" } confirmationNumber: { type: "string" } confirmed: { type: "boolean" } createDate: { type: "string" } customFields: { type: "object" } customerId: { type: "string" } customerMessage: { type: "string" } customers: { type: "array" items: { type: "object" properties: { appointmentId: { type: "string" } customerId: { type: "string" } } additionalProperties: false } } date: { type: "string" } dateInternational: { type: "string" } downloadIcsUrl: { type: "string" } duration: { type: "integer" format: "int32" } email: { type: "string" } emailConfirmationSent: { type: "string" } emailReminderSent: { type: "string" } endDateTime: { type: "string" } firstname: { type: "string" } groupSize: { type: "integer" format: "int32" } id: { type: "string" } ipAddress: { type: "string" } lastModifiedBy: { type: "string" } lastModifiedOn: { type: "string" } lastname: { type: "string" } latitude: { type: "string" } location: { type: "string" } locationId: { type: "string" } longitude: { type: "string" } name: { type: "string" } notes: { type: "string" } object: { type: "string" } onlineBooking: { type: "boolean" } paymentStatus: { type: "integer" format: "int32" } phone: { type: "string" } phoneExt: { type: "string" } phoneType: { type: "string" } rescheduledId: { type: "string" } resourceEmail: { type: "string" } resourceGroupId: { type: "string" } resourceGroupName: { type: "string" } resourceId: { type: "string" } resourceImageUrl: { type: "string" } resourceName: { type: "string" } resources: { type: "array" items: { type: "object" properties: { appointmentId: { type: "string" } resourceEmail: { type: "string" } resourceGroupId: { type: "string" } resourceId: { type: "string" } resourceImageUrl: { type: "string" } resourceName: { type: "string" } } additionalProperties: false } } serviceAllocationId: { type: "string" } serviceId: { type: "string" } serviceImageUrl: { type: "string" } serviceName: { type: "string" } smsConfirmationSent: { type: "string" } smsReminderSent: { type: "string" } startDateTime: { type: "string" } status: { type: "string" } stripeChargeId: { type: "string" } stripeRefundId: { type: "string" } time: { type: "integer" format: "int32" } timezone: { type: "integer" format: "int32" } timezoneIana: { type: "string" } timezoneId: { type: "string" } } additionalProperties: false } }