Create client with the Acuity Scheduling API

Adds a client to the client list and returns it. A client that already exists gets 400 with the message That client already exists.

Identifier
acuity_create_client

The request

POST https://connect.reportei.com/api/tools/acuity_create_client/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "firstName": "<firstName>",
    "lastName": "<lastName>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
firstNamestringYesFirst name of the client.
lastNamestringYesLast name of the client.
emailstringNoEmail address of the client.
phonestringNoPhone number of the client.
notesstringNoNotes about the client.

Supported connections

Your customer connects their Acuity Scheduling account once, with one of the modes below. The same connection serves every tool of the toolkit.

Username and password

Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/acuity_create_client. It becomes your agent's tool definition with no conversion.

Other Acuity Scheduling tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.