- Introduction
- Quickstart
- Webhooks
- Campaign
- Class
- Client
- Retrieves all client for a Tenant
- Creates a new client
- Gets client by ID
- Gets clients birthday list
- Gets clients at risk
- Gets client mandatory fields
- Adds client to blacklist
- Removes client from blacklist
- Updates client details
- Used for partial updates of client details
- Changes client representative
- Lists prospects
- Lists ex-clients
- Resets client password
- Changes client representative for multiple clients
- Lists prospect effective date history
- Transfers prospect
- Company
- Invoice
- Organisation
- Search
- Tax
- Tenant
- Appointments
- Create new appointment
- List appointments
- Change client membership in appointment
- Get appointment
- Update appointment
- Mark client as checked in
- Mark client as no-show
- Substitute coach for appointment
- Reschedule appointment
- Cancel appointment
- List appointments by client ID
- Create appointment complimentory session
- Create appointment
- Reschedule appointment
- Get appointment
- Appointment Types
- Authentication
- Automation
- Call Transactions
- Charge Categories
- Charge Master
- Recurring Class
- Class Booking
- Class Complimentory
- Class Types
- Company level class types
- Client Communication
- Client Tasks
- Client Sales
- Client Waivers
- Client Sessions
- Client Referrals
- Client Offers
- Client Export
- Client Billing
- Client Check-in
- Client Credit Balance
- Client Documents
- Client Invoices
- Client Membership
- Client Open API
- Client Payments
- Client Subscriptions
- Client Memberships
- Client Subscription Cancellation
- Client Subscription Freeze
- Client Trials
- Client Upgrade
- Balance Write Off
- Email Template
- Email Template - Franchise
- Create email template at franchise level
- Get list of email templates at franchise level
- Update email template at franchise level
- Get email template at franchise level
- Delete email template at franchise level
- Mark email template as inactive at franchise level
- Mark email template as active at franchise level
- Email Template - Tenant
- Franchise Groups
- Payment Methods
- Invoices
- Offer Master
- Online Signup
- Subscription
- Sales
- Staff Availability
- List staff availability
- List staff availability by appointment category
- List next available slots by appointment category
- Check staff availability
- Check staff availability for appointment category
- Check staff availability for recurring schedule
- Check staff availability for recurring schedule
- Get staff scheduled unavailability
- List staff availability for tours
- Opportunities
- Opportunity Stage Master
- Payments
- Refunds
- Reports
- Report Filter Schedules
- Access Requests
- Rooms
- Sales Returns
- Email Communication
- SMS
- Service Categories
- Staff Management
- Staff Appointment Type Link
- Staff Notifications
- Staff Schedule
- Subscription Plans
- Subscription Signup
- Tasks
- Task Categories
- Task Open API
- Trial Master
Create client and invoice
PATCH
/open/companies/{company_uuid}/tenants/{tenant_uuid}/online_signup/clients
Request
Path Params
Body Params application/json
Example
[
{
"op": "replace",
"path": "/Prospect",
"value": [
{
"op": "replace",
"path": "/FullName",
"value": " Rojer willi"
},
{
"op": "replace",
"path": "/Gender",
"value": "2"
},
{
"op": "replace",
"path": "/EmailId",
"value": "roger@gmail.com"
},
{
"op": "replace",
"path": "/MobileCountryCode",
"value": "+1"
},
{
"op": "replace",
"path": "/MobileNumber",
"value": "5553422172"
},
{
"op": "replace",
"path": "/Source",
"value": "Website"
},
{
"op": "replace",
"path": "/Channel",
"value": "Online"
},
{
"op": "replace",
"path": "/ReferredBy",
"value": ""
},
{
"op": "replace",
"path": "/PromotionalNotificationChannelsAllowed",
"value": [
"None"
]
},
{
"op": "replace",
"path": "/DateOfBirth",
"value": "1999-02-09T16:00:00.000Z"
}
]
},
{
"op": "replace",
"path": "/SubscriptionPlan",
"value": [
{
"op": "replace",
"path": "/PlanId",
"value": 21230
},
{
"op": "replace",
"path": "/ClientSubscriptionStartDate",
"value": "2025-10-30T16:00:00Z"
},
{
"op": "replace",
"path": "/ClientSubscriptionBillCycleDay",
"value": 1
},
{
"op": "replace",
"path": "/AddonsServiceId",
"value": []
}
]
},
{
"op": "replace",
"path": "/Coupon",
"value": {
"CouponCode": "TEST20"
}
}
]Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/open/companies//tenants//online_signup/clients' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"op": "replace",
"path": "/Prospect",
"value": [
{
"op": "replace",
"path": "/FullName",
"value": " Rojer willi"
},
{
"op": "replace",
"path": "/Gender",
"value": "2"
},
{
"op": "replace",
"path": "/EmailId",
"value": "roger@gmail.com"
},
{
"op": "replace",
"path": "/MobileCountryCode",
"value": "+1"
},
{
"op": "replace",
"path": "/MobileNumber",
"value": "5553422172"
},
{
"op": "replace",
"path": "/Source",
"value": "Website"
},
{
"op": "replace",
"path": "/Channel",
"value": "Online"
},
{
"op": "replace",
"path": "/ReferredBy",
"value": ""
},
{
"op": "replace",
"path": "/PromotionalNotificationChannelsAllowed",
"value": [
"None"
]
},
{
"op": "replace",
"path": "/DateOfBirth",
"value": "1999-02-09T16:00:00.000Z"
}
]
},
{
"op": "replace",
"path": "/SubscriptionPlan",
"value": [
{
"op": "replace",
"path": "/PlanId",
"value": 21230
},
{
"op": "replace",
"path": "/ClientSubscriptionStartDate",
"value": "2025-10-30T16:00:00Z"
},
{
"op": "replace",
"path": "/ClientSubscriptionBillCycleDay",
"value": 1
},
{
"op": "replace",
"path": "/AddonsServiceId",
"value": []
}
]
},
{
"op": "replace",
"path": "/Coupon",
"value": {
"CouponCode": "TEST20"
}
}
]'Responses
🟢200OK
text/plain
Body
Example
{
"signup_status_UUID": "string"
}🟠400Bad Request
Modified at 2025-11-12 20:53:59