Create an Appointment for a Customer

post

https://enerflo.io/api/v1/appointments

Body Params

customer

string

required

The customer parameter can accept two types of values:
1) The email address an Enerflo Customer (useful if your customer email addresses are unique)
2) The Enerflo Customer ID (useful if you allow the same email address to be associated to different customers)

appointment_type

int32

required

The Enerflo ID of the appointment template you wish to create. Valid values vary by company. You can find your appointment IDs here: https://enerflo.io/company/settings/apt-types

start

date

required

This represents the initial date and time of the appointment, formatted as yyyy-mm-dd hh:mm:ss. Please note that if no timezone information is provided, the value is assumed to be in Coordinated Universal Time (UTC).
Example 1: 2023-12-21 11:00:00-05:00 = 11:00 am Eastern Standard Time
Example 2: 2023-12-21 11:00:00-04:00 = 11:00 am Eastern Daylight Time
Example 3: 2023-12-21 11:00:00 = 11:00 am Coordinated Universal Time (UTC)

end

date

required

This represents the ending date and time of the appointment, formatted as yyyy-mm-dd hh:mm:ss. Please note that if no timezone information is provided, the value is assumed to be in Coordinated Universal Time (UTC).
Example 1: 2023-12-21 11:00:00-05:00 = 11:00 am Eastern Standard Time
Example 2: 2023-12-21 11:00:00-04:00 = 11:00 am Eastern Daylight Time
Example 3: 2023-12-21 11:00:00 = 11:00 am Coordinated Universal Time (UTC)

survey

int32

Optional, the id of the survey assigned to this appointment

creator

string

This is the email address of the Enerflo user that is the creator of this appointment.

user

string

This is the email address of the Enerflo user is assigned to this appointment.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400