Acuity Scheduling

App · 25 actions

Run your Acuity Scheduling bookings from workflows: find open times, book, reschedule and cancel appointments, manage clients and blocked time, and start a workflow when an appointment is booked, rescheduled or canceled.

Actions

ActionWhat it does
Add clientAdd a client to the client list.
Block off timeBlock off time on a calendar, such as a holiday or a meeting, so nobody can book it.
Book appointmentBook an appointment for a client at an open time (use 'Get available times' to find one).
Cancel appointmentCancel an appointment as the business, optionally marking it a no-show.
Check a time is openCheck whether a time can be booked for an appointment type, and if not, why.
Check package or coupon codeCheck whether a package, gift certificate or coupon code can be used for an appointment type, and if not, why.
Delete blocked timeRemove blocked-off time, so the time can be booked again.
Delete clientDelete a client from the client list, found by first and last name.
Get accountGet the Acuity account: business name, email, time zone, currency, plan and scheduling page.
Get appointmentGet one appointment with its client, time, calendar, price, label and intake form answers.
Get available datesList the days in a month that have open times for an appointment type, as clients see them.
Get available timesList the open start times on a day for an appointment type.
List appointment paymentsList the payments taken for an appointment, with the amount, date and payment processor.
List appointment typesList the services and classes people can book, with length, price and the calendars each is offered on.
List appointmentsFind appointments by date, calendar, appointment type or client, latest first.
List blocked timesList the time blocked off on calendars, so nobody can book it.
List calendarsList the calendars appointments are booked on: the people, rooms or resources of the business.
List class timesList the class times in a month that still have places, with how many are left.
List clientsFind clients by name or phone number, or list them all.
List intake formsList the intake forms with their questions, each question's id and type, and the appointment types that ask them.
List labelsList the labels appointments can be marked with.
List ordersList orders from the online store (packages, gift certificates, subscriptions and products), newest first.
Reschedule appointmentMove an appointment to another time, or another calendar, or both.
Update appointmentChange an appointment's client details, notes, label, code or intake form answers.
Update clientChange a client found by first and last name.

Add client

Add a client to the client list. Acuity refuses a client it already has.

Inputs

First namefirst_nametextRequired
The client's first name.
Last namelast_nametextRequired
The client's last name.
Emailemailtext
The client's email address.
Phonephonetext
The client's phone number.
Notesnotestext
Notes kept on the client.

Outputs

clientobject
The client
Example output
{
  "client": {
    "email": "",
    "first_name": "Bob",
    "last_name": "Burger",
    "notes": "",
    "phone": "555-555-5555"
  }
}

Block off time

Block off time on a calendar, such as a holiday or a meeting, so nobody can book it.

Inputs

Calendarcalendar_idtextRequired
The calendar to block time on.
Startstartdate and timeRequired
When the blocked time starts.
Endenddate and timeRequired
When the blocked time ends.
Notesnotestext
Why it is blocked, shown on the calendar.

Outputs

blockobject
The blocked time
Example output
{
  "block": {
    "calendar_id": "1",
    "description": "Wednesday 17 June 2015 3:00am - 4:00am",
    "end": "2015-06-17T04:00:00-07:00",
    "id": "174453240",
    "notes": "Test 1",
    "recurring": "",
    "start": "2015-06-17T03:00:00-07:00",
    "until": ""
  }
}

Book appointment

Book an appointment for a client at an open time (use 'Get available times' to find one). Acuity emails the client a confirmation unless switched off.

Inputs

Appointment typeappointment_type_idtextRequired
The service or class. Pick one, or give its id.
Date and timestart_timedate and timeRequired
When the appointment starts. A time from 'Get available times' can be used as it is.
First namefirst_nametextRequired
The client's first name.
Last namelast_nametextRequired
The client's last name.
Emailemailtext
The client's email address. Required unless booking even if the time isn't open.
Phonephonetext
The client's phone number.
Calendarcalendar_idtext
Whose calendar to book on. Leave empty for Acuity to pick one with the time open.
Client's time zonetime_zonetext
The time zone the client sees times in, such as America/New_York. Defaults to the business's.
Labellabel_idtext
A label to mark the appointment with, such as Confirmed.
Package or coupon codecertificatetext
A package, gift certificate or coupon code to apply.
Intake form answersform_answersobject
Answers to the appointment type's intake form questions. For a checkbox list, separate the choices with commas.
Book even if the time isn't openbook_anywaytrue/false
Book as the business, skipping Acuity's availability and booking rules. Needs a calendar.Default: false.
Email the clientsend_confirmationtrue/false
Send Acuity's confirmation email and text message.Default: true.

Outputs

appointmentobject
The appointment
Example output
{
  "appointment": {
    "amount_paid": 0.0,
    "answers": [
      {
        "answer": "yes",
        "form": "Example Intake Form",
        "question": "Is this your first visit?",
        "question_id": "1"
      },
      {
        "answer": "Ninja",
        "form": "Example Intake Form",
        "question": "What is your goal for this appointment?",
        "question_id": "2"
      }
    ],
    "appointment_type": "Regular Visit",
    "appointment_type_id": "1",
    "calendar": "My Calendar",
    "calendar_id": "27238",
    "certificate": "",
    "class_id": "",
    "confirmation_page": "https://acuityscheduling.com/schedule.php?owner=11145481&id[]=1220aa9f41091c50c0cc659385cfa1d0&action=appt",
    "created_on": "2013-07-02",
    "date": "June 17, 2013",
    "datetime": "2013-06-17T10:15:00-07:00",
    "duration_minutes": 60.0,
    "email": "bob.mctest@example.com",
    "end_datetime": "2013-06-17T11:15:00-07:00",
    "end_time": "11:15am",
    "first_name": "Bob",
    "id": "54321",
    "label": "Completed",
    "labels": [
      {
        "color": "pink",
        "id": "3",
        "name": "Completed"
      }
    ],
    "last_name": "McTest",
    "location": "",
    "no_show": false,
    "notes": "Notes",
    "paid": false,
    "phone": "",
    "price": 10.0,
    "time": "10:15am",
    "timezone": "America/New_York"
  }
}

Cancel appointment

Cancel an appointment as the business, optionally marking it a no-show. A canceled appointment can't be restored.

Inputs

Appointment IDappointment_idtextRequired
The appointment's id, from 'List appointments', 'Book appointment' or a trigger.
Message to the clientreasontext
Sent with the cancellation email.
No-showno_showtrue/false
Mark it as a no-show rather than a cancellation.Default: false.
Email the clientsend_notificationtrue/false
Send Acuity's email and text message about the change.Default: true.

Outputs

appointmentobject
The appointment
Example output
{
  "appointment": {
    "amount_paid": 0.0,
    "answers": [
      {
        "answer": "yes",
        "form": "Example Intake Form",
        "question": "Is this your first visit?",
        "question_id": "1"
      },
      {
        "answer": "Ninja",
        "form": "Example Intake Form",
        "question": "What is your goal for this appointment?",
        "question_id": "2"
      }
    ],
    "appointment_type": "Regular Visit",
    "appointment_type_id": "1",
    "calendar": "My Calendar",
    "calendar_id": "1",
    "certificate": "",
    "class_id": "",
    "confirmation_page": "https://acuityscheduling.com/schedule.php?owner=11145481&id[]=1220aa9f41091c50c0cc659385cfa1d0&action=appt",
    "created_on": "2013-07-02",
    "date": "June 17, 2013",
    "datetime": "2013-06-17T10:15:00-07:00",
    "duration_minutes": 60.0,
    "email": "bob.mctest@example.com",
    "end_datetime": "2013-06-17T11:15:00-07:00",
    "end_time": "11:15am",
    "first_name": "Bob",
    "id": "1",
    "label": "Completed",
    "labels": [
      {
        "color": "pink",
        "id": "3",
        "name": "Completed"
      }
    ],
    "last_name": "McTest",
    "location": "",
    "no_show": false,
    "notes": "Notes",
    "paid": false,
    "phone": "",
    "price": 10.0,
    "time": "10:15am",
    "timezone": "America/New_York"
  }
}

Check a time is open

Check whether a time can be booked for an appointment type, and if not, why. A time that isn't open is an answer, not an error.

Inputs

Appointment typeappointment_type_idtextRequired
The service or class. Pick one, or give its id.
Date and timestart_timedate and timeRequired
The time to check.
Calendarcalendar_idtext
Only this calendar. Leave empty for every calendar the appointment type is offered on.

Outputs

availabletrue/false
Whether it can be booked
calendar_idtext
The calendar checked
datetimetext
The time checked
reasontext
Why not, when it can't
Example output
{
  "available": true,
  "calendar_id": "1",
  "datetime": "2017-11-15T16:00:00-0800",
  "reason": ""
}

Check package or coupon code

Check whether a package, gift certificate or coupon code can be used for an appointment type, and if not, why.

Inputs

CodecodetextRequired
The package, gift certificate or coupon code.
Appointment typeappointment_type_idtextRequired
The service or class. Pick one, or give its id.
Client emailemailtext
Also check the code for this client, such as a coupon each client may use once.

Outputs

certificateobject
The code
reasontext
Why not, when it can't
validtrue/false
Whether it can be used
Example output
{
  "certificate": {
    "appointment_type_ids": [
      "1"
    ],
    "code": "BFB0E13E",
    "email": "",
    "expiration": "",
    "id": "1",
    "kind": "appointments",
    "name": "5 Small Builds",
    "order_id": "",
    "product_id": "1",
    "remaining_minutes": 0.0
  },
  "reason": "",
  "valid": true
}

Delete blocked time

Remove blocked-off time, so the time can be booked again.

Inputs

Blocked time IDblock_idtextRequired
The blocked time's id, from 'List blocked times' or 'Block off time'.

Outputs

block_idtext
The blocked time deleted
deletedtrue/false
Always true once deleted
Example output
{
  "block_id": "174453240",
  "deleted": true
}

Delete client

Delete a client from the client list, found by first and last name.

Inputs

First namefirst_nametextRequired
The client's first name, exactly as in Acuity.
Last namelast_nametextRequired
The client's last name, exactly as in Acuity.
Phonephonetext
The client's phone number, to tell apart two clients with the same name.

Outputs

deletedtrue/false
Always true once deleted
first_nametext
The client's first name
last_nametext
The client's last name
Example output
{
  "deleted": true,
  "first_name": "Bob",
  "last_name": "McTest"
}

Get account

Get the Acuity account: business name, email, time zone, currency, plan and scheduling page.

Inputs

None.

Outputs

accountobject
The account
Example output
{
  "account": {
    "currency": "USD",
    "description": "",
    "email": "example@acuityscheduling.com",
    "id": "1",
    "name": "Example",
    "plan": "Professional",
    "scheduling_page": "https://example.acuityscheduling.com/",
    "time_format": "ampm",
    "timezone": "America/New_York"
  }
}

Get appointment

Get one appointment with its client, time, calendar, price, label and intake form answers.

Inputs

Appointment IDappointment_idtextRequired
The appointment's id, from 'List appointments', 'Book appointment' or a trigger.

Outputs

appointmentobject
The appointment
Example output
{
  "appointment": {
    "amount_paid": 0.0,
    "answers": [
      {
        "answer": "yes",
        "form": "Example Intake Form",
        "question": "Is this your first visit?",
        "question_id": "1"
      },
      {
        "answer": "Ninja",
        "form": "Example Intake Form",
        "question": "What is your goal for this appointment?",
        "question_id": "2"
      }
    ],
    "appointment_type": "Regular Visit",
    "appointment_type_id": "1",
    "calendar": "My Calendar",
    "calendar_id": "27238",
    "certificate": "",
    "class_id": "",
    "confirmation_page": "https://acuityscheduling.com/schedule.php?owner=11145481&id[]=1220aa9f41091c50c0cc659385cfa1d0&action=appt",
    "created_on": "2013-07-02",
    "date": "June 17, 2013",
    "datetime": "2013-06-17T10:15:00-07:00",
    "duration_minutes": 60.0,
    "email": "bob.mctest@example.com",
    "end_datetime": "2013-06-17T11:15:00-07:00",
    "end_time": "11:15am",
    "first_name": "Bob",
    "id": "54321",
    "label": "Completed",
    "labels": [
      {
        "color": "pink",
        "id": "3",
        "name": "Completed"
      }
    ],
    "last_name": "McTest",
    "location": "",
    "no_show": false,
    "notes": "Notes",
    "paid": false,
    "phone": "",
    "price": 10.0,
    "time": "10:15am",
    "timezone": "America/New_York"
  }
}

Get available dates

List the days in a month that have open times for an appointment type, as clients see them.

Inputs

Appointment typeappointment_type_idtextRequired
The service or class. Pick one, or give its id.
Monthmonthdate
Pick any day in the month. Defaults to this month.
Calendarcalendar_idtext
Only this calendar. Leave empty for every calendar the appointment type is offered on.
Time zonetime_zonetext
Show times in this time zone. Defaults to the business's.

Outputs

countnumber
How many are returned
dateslist
Days with open times
monthtext
The month (YYYY-MM)
Example output
{
  "count": 2,
  "dates": [
    "2016-02-04",
    "2016-02-05"
  ],
  "month": "2016-02"
}

Get available times

List the open start times on a day for an appointment type. Each can be booked with 'Book appointment' as it is.

Inputs

Appointment typeappointment_type_idtextRequired
The service or class. Pick one, or give its id.
DatedaydateRequired
The day to look at.
Calendarcalendar_idtext
Only this calendar. Leave empty for every calendar the appointment type is offered on.
Time zonetime_zonetext
Show times in this time zone. Defaults to the business's.

Outputs

countnumber
How many are returned
datetext
The day (YYYY-MM-DD)
timeslist
Open start times
Example output
{
  "count": 2,
  "date": "2016-02-04",
  "times": [
    "2016-02-04T13:00:00-0800",
    "2016-02-04T14:00:00-0800"
  ]
}

List appointment payments

List the payments taken for an appointment, with the amount, date and payment processor.

Inputs

Appointment IDappointment_idtextRequired
The appointment's id, from 'List appointments', 'Book appointment' or a trigger.

Outputs

countnumber
How many are returned
paymentslist
The payments
totalnumber
The payments added up
Example output
{
  "count": 1,
  "payments": [
    {
      "amount": 300.0,
      "created": "2016-01-22T09:27:51-08:00",
      "processor": "stripe",
      "transaction_id": "pi_123456abcdef"
    }
  ],
  "total": 300.0
}

List appointment types

List the services and classes people can book, with length, price and the calendars each is offered on.

Inputs

None.

Outputs

appointment_typeslist
The appointment types
countnumber
How many are returned
Example output
{
  "appointment_types": [
    {
      "active": true,
      "calendar_ids": [
        "1"
      ],
      "category": "Parties",
      "class_size": 0.0,
      "color": "#E3DE7D",
      "description": "",
      "duration_minutes": 150.0,
      "id": "5",
      "kind": "service",
      "name": "Lego Party",
      "price": 200.0,
      "private": false
    }
  ],
  "count": 1
}

List appointments

Find appointments by date, calendar, appointment type or client, latest first. Canceled ones are left out unless asked for.

Inputs

Frommin_datedate
Only those on or after this day.
Tomax_datedate
Only those on or before this day.
Calendarcalendar_idtext
Only this calendar.
Appointment typeappointment_type_idtext
Only this service or class.
Statusstatustext
Scheduled appointments, canceled ones, or both.One of: scheduled (Scheduled (default)), canceled, all (Scheduled and canceled). Default: scheduled.
Client emailemailtext
Only this client's appointments, by email address.
Client first namefirst_nametext
Only clients with this first name.
Client last namelast_nametext
Only clients with this last name.
Client phonephonetext
Only clients with this phone number.
Orderordertext
Latest appointment first, or earliest first.One of: latest (Latest first (default)), earliest (Earliest first). Default: latest.
Most to returnlimitnumber
How many to return at most, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

appointmentslist
The matching appointments
countnumber
How many are returned
Example output
{
  "appointments": [
    {
      "amount_paid": 0.0,
      "answers": [
        {
          "answer": "yes",
          "form": "Example Intake Form",
          "question": "Is this your first visit?",
          "question_id": "1"
        },
        {
          "answer": "Ninja",
          "form": "Example Intake Form",
          "question": "What is your goal for this appointment?",
          "question_id": "2"
        }
      ],
      "appointment_type": "Regular Visit",
      "appointment_type_id": "1",
      "calendar": "My Calendar",
      "calendar_id": "27238",
      "certificate": "",
      "class_id": "",
      "confirmation_page": "https://acuityscheduling.com/schedule.php?owner=11145481&id[]=1220aa9f41091c50c0cc659385cfa1d0&action=appt",
      "created_on": "2013-07-02",
      "date": "June 17, 2013",
      "datetime": "2013-06-17T10:15:00-07:00",
      "duration_minutes": 60.0,
      "email": "bob.mctest@example.com",
      "end_datetime": "2013-06-17T11:15:00-07:00",
      "end_time": "11:15am",
      "first_name": "Bob",
      "id": "54321",
      "label": "Completed",
      "labels": [
        {
          "color": "pink",
          "id": "3",
          "name": "Completed"
        }
      ],
      "last_name": "McTest",
      "location": "",
      "no_show": false,
      "notes": "Notes",
      "paid": false,
      "phone": "",
      "price": 10.0,
      "time": "10:15am",
      "timezone": "America/New_York"
    }
  ],
  "count": 1
}

List blocked times

List the time blocked off on calendars, so nobody can book it.

Inputs

Frommin_datedate
Only those on or after this day.
Tomax_datedate
Only those on or before this day.
Calendarcalendar_idtext
Only this calendar.
Most to returnlimitnumber
How many to return at most, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

blockslist
The blocked times
countnumber
How many are returned
Example output
{
  "blocks": [
    {
      "calendar_id": "1",
      "description": "Wednesday  1 July 2015 11:00am - 12:00pm",
      "end": "2015-07-01T12:00:00-07:00",
      "id": "1",
      "notes": "Blocked time.",
      "recurring": "",
      "start": "2015-07-01T11:00:00-07:00",
      "until": ""
    }
  ],
  "count": 1
}

List calendars

List the calendars appointments are booked on: the people, rooms or resources of the business.

Inputs

None.

Outputs

calendarslist
The calendars
countnumber
How many are returned
Example output
{
  "calendars": [
    {
      "description": "",
      "email": "joecontractor@example.com",
      "id": "4321",
      "location": "",
      "name": "Joe",
      "reply_to": "joecontractor@example.com",
      "timezone": "America/New_York"
    }
  ],
  "count": 1
}

List class times

List the class times in a month that still have places, with how many are left.

Inputs

Monthmonthdate
Pick any day in the month. Defaults to this month.
Appointment typeappointment_type_idtext
Only this service or class.
Calendarcalendar_idtext
Only this calendar.
Time zonetime_zonetext
Show times in this time zone. Defaults to the business's.

Outputs

classeslist
The class times
countnumber
How many are returned
monthtext
The month (YYYY-MM)
Example output
{
  "classes": [
    {
      "appointment_type_id": "8",
      "calendar": "More Calendar",
      "calendar_id": "2",
      "duration_minutes": 30.0,
      "id": "1",
      "name": "Become a Better Builder",
      "series": false,
      "slots": 8.0,
      "slots_available": 8.0,
      "time": "2016-02-10T18:00:00-08:00"
    }
  ],
  "count": 1,
  "month": "2016-02"
}

List clients

Find clients by name or phone number, or list them all.

Inputs

Searchsearchtext
A first name, last name or phone number to look for.

Outputs

clientslist
The matching clients
countnumber
How many are returned
Example output
{
  "clients": [
    {
      "email": "",
      "first_name": "Bob",
      "last_name": "McTest",
      "notes": "",
      "phone": ""
    }
  ],
  "count": 1
}

List intake forms

List the intake forms with their questions, each question's id and type, and the appointment types that ask them.

Inputs

None.

Outputs

countnumber
How many are returned
formslist
The intake forms
Example output
{
  "count": 1,
  "forms": [
    {
      "appointment_type_ids": [
        "1",
        "2"
      ],
      "description": "This form has got it all!",
      "hidden": false,
      "id": "3",
      "name": "Kitchen Sink",
      "questions": [
        {
          "id": "7",
          "name": "What is your text?",
          "options": [],
          "required": false,
          "type": "textbox"
        },
        {
          "id": "9",
          "name": "Which are your drop downs?",
          "options": [
            "First",
            "Second",
            "Third"
          ],
          "required": false,
          "type": "dropdown"
        },
        {
          "id": "15",
          "name": "Required?",
          "options": [],
          "required": true,
          "type": "textbox"
        }
      ]
    }
  ]
}

List labels

List the labels appointments can be marked with.

Inputs

None.

Outputs

countnumber
How many are returned
labelslist
The labels
Example output
{
  "count": 1,
  "labels": [
    {
      "color": "yellow",
      "id": "1",
      "name": "Confirmed"
    }
  ]
}

List orders

List orders from the online store (packages, gift certificates, subscriptions and products), newest first.

Inputs

Most to returnlimitnumber
How many to return at most, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many are returned
orderslist
The orders
Example output
{
  "count": 1,
  "orders": [
    {
      "email": "test@example.com",
      "first_name": "Testy",
      "id": "1234",
      "last_name": "McTest",
      "notes": "Some notes from the client",
      "phone": "1234567890",
      "products": "Massage Gift Certificate, Relaxing Candle",
      "status": "paid",
      "time": "2014-09-23 14:22",
      "total": 55.0
    }
  ]
}

Reschedule appointment

Move an appointment to another time, or another calendar, or both. The new time must be open unless booking anyway.

Inputs

Appointment IDappointment_idtextRequired
The appointment's id, from 'List appointments', 'Book appointment' or a trigger.
New date and timestart_timedate and timeRequired
When the appointment starts now. A time from 'Get available times' can be used as it is.
Calendarcalendar_idtext
Move it to this calendar. Leave empty to keep its calendar.
Client's time zonetime_zonetext
The time zone the client sees times in, such as America/New_York. Defaults to the business's.
Book even if the time isn't openbook_anywaytrue/false
Book as the business, skipping Acuity's availability and booking rules. Needs a calendar.Default: false.
Email the clientsend_notificationtrue/false
Send Acuity's email and text message about the change.Default: true.

Outputs

appointmentobject
The appointment
Example output
{
  "appointment": {
    "amount_paid": 0.0,
    "answers": [
      {
        "answer": "yes",
        "form": "Example Intake Form",
        "question": "Is this your first visit?",
        "question_id": "1"
      },
      {
        "answer": "Ninja",
        "form": "Example Intake Form",
        "question": "What is your goal for this appointment?",
        "question_id": "2"
      }
    ],
    "appointment_type": "Regular Visit",
    "appointment_type_id": "1",
    "calendar": "My Calendar",
    "calendar_id": "27238",
    "certificate": "",
    "class_id": "",
    "confirmation_page": "https://acuityscheduling.com/schedule.php?owner=11145481&id[]=1220aa9f41091c50c0cc659385cfa1d0&action=appt",
    "created_on": "2013-07-02",
    "date": "June 17, 2013",
    "datetime": "2013-06-17T10:15:00-07:00",
    "duration_minutes": 60.0,
    "email": "bob.mctest@example.com",
    "end_datetime": "2013-06-17T11:15:00-07:00",
    "end_time": "11:15am",
    "first_name": "Bob",
    "id": "54321",
    "label": "Completed",
    "labels": [
      {
        "color": "pink",
        "id": "3",
        "name": "Completed"
      }
    ],
    "last_name": "McTest",
    "location": "",
    "no_show": false,
    "notes": "Notes",
    "paid": false,
    "phone": "",
    "price": 10.0,
    "time": "10:15am",
    "timezone": "America/New_York"
  }
}

Update appointment

Change an appointment's client details, notes, label, code or intake form answers. Only the fields given change.

Inputs

Appointment IDappointment_idtextRequired
The appointment's id, from 'List appointments', 'Book appointment' or a trigger.
First namefirst_nametext
A new first name for the client.
Last namelast_nametext
A new last name for the client.
Emailemailtext
A new email address for the client.
Phonephonetext
The client's phone number.
Notesnotestext
Notes kept on the appointment. Replaces any notes it has.
Labellabel_idtext
A label to mark the appointment with, such as Confirmed.
Package or coupon codecertificatetext
A package, gift certificate or coupon code to apply.
Intake form answersform_answersobject
Answers to the appointment type's intake form questions. For a checkbox list, separate the choices with commas.

Outputs

appointmentobject
The appointment
Example output
{
  "appointment": {
    "amount_paid": 0.0,
    "answers": [
      {
        "answer": "yes",
        "form": "Example Intake Form",
        "question": "Is this your first visit?",
        "question_id": "1"
      },
      {
        "answer": "Ninja",
        "form": "Example Intake Form",
        "question": "What is your goal for this appointment?",
        "question_id": "2"
      }
    ],
    "appointment_type": "Regular Visit",
    "appointment_type_id": "1",
    "calendar": "My Calendar",
    "calendar_id": "27238",
    "certificate": "",
    "class_id": "",
    "confirmation_page": "https://acuityscheduling.com/schedule.php?owner=11145481&id[]=1220aa9f41091c50c0cc659385cfa1d0&action=appt",
    "created_on": "2013-07-02",
    "date": "June 17, 2013",
    "datetime": "2013-06-17T10:15:00-07:00",
    "duration_minutes": 60.0,
    "email": "bob.mctest@example.com",
    "end_datetime": "2013-06-17T11:15:00-07:00",
    "end_time": "11:15am",
    "first_name": "Bob",
    "id": "54321",
    "label": "Completed",
    "labels": [
      {
        "color": "pink",
        "id": "3",
        "name": "Completed"
      }
    ],
    "last_name": "McTest",
    "location": "",
    "no_show": false,
    "notes": "Notes",
    "paid": false,
    "phone": "",
    "price": 10.0,
    "time": "10:15am",
    "timezone": "America/New_York"
  }
}

Update client

Change a client found by first and last name. Fields left empty keep their values.

Inputs

First namefirst_nametextRequired
The client's first name, exactly as in Acuity.
Last namelast_nametextRequired
The client's last name, exactly as in Acuity.
New first namenew_first_nametext
A new first name.
New last namenew_last_nametext
A new last name.
Emailemailtext
A new email address.
Phonephonetext
A new phone number.
Notesnotestext
Notes kept on the client. Replaces any notes they have.

Outputs

clientobject
The client
Example output
{
  "client": {
    "email": "",
    "first_name": "Bob",
    "last_name": "Burger",
    "notes": "",
    "phone": "555-555-5555"
  }
}

On this page