Create a new client
POST /v1/clients
- Scope
clients:write- Roles
- admin, scheduler
Creates a new client with associated preferences, documents, billing, and other details. Rates & Billing fields (rates, single rates, admin fee, billing and cancellation terms) need Finance Write: without it they are left out and the new record takes the organization's.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
113 top-level fields; 39 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
name required | string | max length 255. Example |
clientType required | object (2 nested) | Required on create. |
email | string (email) or null | Required when portalAccess or networkAccess is true. Unique among clients. max length 255. Example |
description | string or null | min length 5, max length 2000. |
logo | string (binary) or null | jpg, jpeg or png, max 2 MB. |
isPublished | boolean or null | Example |
status | object (2 nested) | |
priority | object (2 nested) | |
portalAccess | boolean or null | Let the client sign in to the client portal. Example |
networkAccess | boolean or null | Share the client with the Fido network. Example |
roles | array of object or null (3 nested) | |
formId | string or null | Intake form the client came from. |
industry | array of object or null (2 nested) | |
gender | object (2 nested) | |
hearingStatus | object (2 nested) | |
dateOfBirth | string (date) or null | |
internalNotes | string or null | min length 2, max length 2000. |
enableCalendarIntegration | boolean or null | |
countryCode | string or null | max length 5. Example |
phone | string or null | Required when receiveSms is true. max length 20. Example |
phoneType | string or null | One of: |
phoneExtension | string or null | max length 10. Example |
videoPhoneCountryCode | string or null | max length 5. Example |
videoPhone | string or null | max length 20. |
addressLine1 | string or null | Primary location address. max length 255. Example |
addressLine2 | string or null | max length 255. |
city | string or null | max length 100. Example |
state | object (2 nested) | |
postalCode | string or null | 12345 or 12345-6789. Example |
accessInstruction | string or null | |
timezone | string or null | Example |
shiftCapacity | boolean or null | Example |
minimumCapacity | integer or null | Required when shiftCapacity is true; at most maximumCapacity. min 0. |
maximumCapacity | integer or null | Required when shiftCapacity is true; at least minimumCapacity. min 1. |
billingAddressDifferent | boolean or null | |
billingStreetAddress | string or null | |
billingStreetAddressLine2 | string or null | |
billingCity | string or null | |
billingState | object (2 nested) | |
billingPostalCode | string or null | |
department | string or null | Primary location contact. max length 255. |
contactName | string or null | max length 255. |
role | string or null | max length 255. |
contactEmail | string (email) or null | max length 255. |
contactImage | string (binary) or null | jpg, jpeg, png or gif, max 2 MB. |
contactPhoneCountryCode | string or null | Example |
contactPhone | string or null | Required when receiveSms is true. |
contactPhoneType | string or null | One of: |
contactPhoneExtension | string or null | |
contactVideoPhoneCountryCode | string or null | Example |
contactVideoPhone | string or null | |
assignmentRequest | boolean or null | Notification preference. |
assignmentUpdates | boolean or null | Notification preference. |
allowClientsToBroadcastImmediately | boolean or null | The client's requests broadcast without scheduler review. |
receiveEmail | boolean or null | Notification preference. |
receiveSms | boolean or null | Notification preference. |
receiveInApp | boolean or null | Notification preference. |
defaultTimezone | string or null | Localization. |
defaultLanguage | object (2 nested) | Localization. |
dateFormat | object (2 nested) | Localization. |
timeFormat | string or null | Localization. |
startOfWeek | string or null | Localization. Example |
startOfDay | string or null | Localization. Example |
endOfDay | string or null | Localization. Example |
preferredServiceLocations | object (2 nested) | Localization. |
associatedConsumer | array of object or null (9 nested) | Consumers associated with the client. |
userRestricted | array of object or null (2 nested) | |
userPreferred | array of object or null (2 nested) | |
consumerRestricted | array of object or null (2 nested) | |
customizeRequirementPreferences | boolean or null | Per-service-type requirements. true reads requirementAndPreferences; false reads the flat default-tier fields below. |
serviceTypes | array of object or null (2 nested) | Default requirement tier. Service types. |
serviceProviderTypes | array of object or null (2 nested) | Default requirement tier. Provider roles. |
providerTypes | array of object or null (2 nested) | Default requirement tier. Provider types. |
skills | object or null (2 nested) | Default requirement tier. Minimum skill level. |
genderPreferences | object or null (2 nested) | Default requirement tier. Preferred provider gender. |
certifications | array of object or null (4 nested) | Default requirement tier. Required certifications. |
clearances | array of object or null (4 nested) | Default requirement tier. Required clearances. |
specializations | array of object or null (2 nested) | Default requirement tier. Required specializations. |
restrictedClients | array of object or null (2 nested) | Clients this client may not be scheduled with. |
clientRestricted | array of object or null (2 nested) | Client users restricted from this client. |
clientLocation | object or null (1 nested) | Existing client location to attach this client to. |
expenses | array of object or null (2 nested) | Reimbursable expense categories enabled for this client. |
requirementAndPreferences | array of object or null (23 nested) | |
customizeRateBilling | boolean or null | Use the client's own rates and billing instead of the organization defaults. Makes billingFrequency and invoiceFrequency required. |
adminFee | number or null | |
adminFeeMethod | string or null | Example |
adminFeeType | string or null | One of: |
rates | array of object or null (24 nested) | |
singleRates | array of object or null (12 nested) | |
reimbursableExpenses | array of object or null (2 nested) | |
applyCancellationFee | boolean or null | |
feeType | string or null | Required when applyCancellationFee is true. full clears feeValue. One of: |
feeValue | number or null | min 0. |
cancellationWindow | object (2 nested) | Required when applyCancellationFee is true. |
paymentTerm | object (2 nested) | |
autoGenerateInvoice | boolean or null | |
autoSendInvoice | boolean or null | |
autoGenerateProForma | boolean or null | |
autoSendProForma | boolean or null | |
billingFrequency | object (2 nested) | |
invoiceFrequency | object (2 nested) | |
proFormaGroupsPerCycle | integer or null | Required with billingFrequency or invoiceFrequency. min 1, max 12. |
beginBillingSchedule | string (date) or null | Required with billingFrequency or invoiceFrequency. |
invoiceSendDay | object (2 nested) | Required with billingFrequency or invoiceFrequency. |
proFormaSendSchedule | array of object or null (2 nested) | Required with billingFrequency or invoiceFrequency. |
billingResponsibility | string or null | |
expenseApprovalAccess | boolean or null | |
requireVerifiedTimeDocumentation | boolean or null | |
documents | array of object or null (9 nested) | pdf, doc, docx, xls, xlsx, csv, png or jpg, max 2 MB each. |
customFields | object or null | Custom field values keyed by field id. |
externalCustomFields | object or null | Values for the external custom fields, keyed by field id. |
isDuplicated | boolean or null | Set when this create duplicates an existing client; records a duplication audit event instead of a plain create. Example |
duplicateId | string or null | The client being duplicated. Read only with isDuplicated=true. Example |
Nested fields
clientType 2 fields
| Field | Type | Description |
|---|---|---|
clientType.id | integer or string | Example |
clientType.label | string or null | Example |
status 2 fields
| Field | Type | Description |
|---|---|---|
status.id | integer or string | Example |
status.label | string or null | Example |
priority 2 fields
| Field | Type | Description |
|---|---|---|
priority.id | integer or string | Example |
priority.label | string or null | Example |
roles 3 fields
| Field | Type | Description |
|---|---|---|
roles[].id | integer or null | Role id. Resolved from slug when omitted. Example |
roles[].slug | string | Example |
roles[].enabled | boolean | Example |
industry 2 fields
| Field | Type | Description |
|---|---|---|
industry[].id | integer or string | Example |
industry[].label | string or null | Example |
gender 2 fields
| Field | Type | Description |
|---|---|---|
gender.id | integer or string | Example |
gender.label | string or null | Example |
hearingStatus 2 fields
| Field | Type | Description |
|---|---|---|
hearingStatus.id | integer or string | Example |
hearingStatus.label | string or null | Example |
state 2 fields
| Field | Type | Description |
|---|---|---|
state.id | integer or string | Example |
state.label | string or null | Example |
billingState 2 fields
| Field | Type | Description |
|---|---|---|
billingState.id | integer or string | Example |
billingState.label | string or null | Example |
defaultLanguage 2 fields
| Field | Type | Description |
|---|---|---|
defaultLanguage.id | integer or string | Example |
defaultLanguage.label | string or null | Example |
dateFormat 2 fields
| Field | Type | Description |
|---|---|---|
dateFormat.id | integer or string | Example |
dateFormat.label | string or null | Example |
preferredServiceLocations 2 fields
| Field | Type | Description |
|---|---|---|
preferredServiceLocations.id | integer or string | Example |
preferredServiceLocations.label | string or null | Example |
associatedConsumer 9 fields
| Field | Type | Description |
|---|---|---|
associatedConsumer[].consumer | object | |
associatedConsumer[].consumer.id | integer or string | Example |
associatedConsumer[].consumer.label | string or null | Example |
associatedConsumer[].relationship | object | |
associatedConsumer[].relationship.id | integer or string | Example |
associatedConsumer[].relationship.label | string or null | Example |
associatedConsumer[].portalAccess | boolean or null | |
associatedConsumer[].allowServiceRequests | boolean or null | |
associatedConsumer[].allowAssignmentChanges | boolean or null |
userRestricted 2 fields
| Field | Type | Description |
|---|---|---|
userRestricted[].id | integer or string | Example |
userRestricted[].label | string or null | Example |
userPreferred 2 fields
| Field | Type | Description |
|---|---|---|
userPreferred[].id | integer or string | Example |
userPreferred[].label | string or null | Example |
consumerRestricted 2 fields
| Field | Type | Description |
|---|---|---|
consumerRestricted[].id | integer or string | Example |
consumerRestricted[].label | string or null | Example |
serviceTypes 2 fields
| Field | Type | Description |
|---|---|---|
serviceTypes[].id | integer or string | Example |
serviceTypes[].label | string or null | Example |
serviceProviderTypes 2 fields
| Field | Type | Description |
|---|---|---|
serviceProviderTypes[].id | integer or string | Example |
serviceProviderTypes[].label | string or null | Example |
providerTypes 2 fields
| Field | Type | Description |
|---|---|---|
providerTypes[].id | integer or string | Example |
providerTypes[].label | string or null | Example |
skills 2 fields
| Field | Type | Description |
|---|---|---|
skills.id | integer or string | Example |
skills.label | string or null | Example |
genderPreferences 2 fields
| Field | Type | Description |
|---|---|---|
genderPreferences.id | integer or string | Example |
genderPreferences.label | string or null | Example |
certifications 4 fields
| Field | Type | Description |
|---|---|---|
certifications[].id required | integer or string | Example |
certifications[].file | string (binary) or null | Supporting document. |
certifications[].startDate | string (date) or null | |
certifications[].endDate | string (date) or null |
clearances 4 fields
| Field | Type | Description |
|---|---|---|
clearances[].id required | integer or string | Example |
clearances[].file | string (binary) or null | Supporting document. |
clearances[].startDate | string (date) or null | |
clearances[].endDate | string (date) or null |
specializations 2 fields
| Field | Type | Description |
|---|---|---|
specializations[].id | integer or string | Example |
specializations[].label | string or null | Example |
restrictedClients 2 fields
| Field | Type | Description |
|---|---|---|
restrictedClients[].id | integer or string | Example |
restrictedClients[].label | string or null | Example |
clientRestricted 2 fields
| Field | Type | Description |
|---|---|---|
clientRestricted[].id | integer or string | Example |
clientRestricted[].label | string or null | Example |
clientLocation 1 fields
| Field | Type | Description |
|---|---|---|
clientLocation.id | integer or string | Example |
expenses 2 fields
| Field | Type | Description |
|---|---|---|
expenses[].id required | integer or string | Example |
expenses[].label | string or null | Example |
requirementAndPreferences 23 fields
| Field | Type | Description |
|---|---|---|
requirementAndPreferences[].id | integer or null | Example |
requirementAndPreferences[].isDefault | boolean | Example |
requirementAndPreferences[].serviceType | object | |
requirementAndPreferences[].serviceType.id | integer or string | Example |
requirementAndPreferences[].serviceType.label | string or null | Example |
requirementAndPreferences[].serviceProviderType | object | |
requirementAndPreferences[].serviceProviderType.id | integer or string | Example |
requirementAndPreferences[].serviceProviderType.label | string or null | Example |
requirementAndPreferences[].skill | object | |
requirementAndPreferences[].skill.id | integer or string | Example |
requirementAndPreferences[].skill.label | string or null | Example |
requirementAndPreferences[].gender | object | |
requirementAndPreferences[].gender.id | integer or string | Example |
requirementAndPreferences[].gender.label | string or null | Example |
requirementAndPreferences[].certification | array of object | |
requirementAndPreferences[].certification[].id | integer or string | Example |
requirementAndPreferences[].certification[].label | string or null | Example |
requirementAndPreferences[].clearance | array of object | |
requirementAndPreferences[].clearance[].id | integer or string | Example |
requirementAndPreferences[].clearance[].label | string or null | Example |
requirementAndPreferences[].specialization | array of object | |
requirementAndPreferences[].specialization[].id | integer or string | Example |
requirementAndPreferences[].specialization[].label | string or null | Example |
rates 24 fields
| Field | Type | Description |
|---|---|---|
rates[].id | integer or null | Example |
rates[].serviceType | object | |
rates[].serviceType.id | integer or string | Example |
rates[].serviceType.label | string or null | Example |
rates[].serviceProviderType | object | |
rates[].serviceProviderType.id | integer or string | Example |
rates[].serviceProviderType.label | string or null | Example |
rates[].siteType | object | |
rates[].siteType.id | integer or string | Example |
rates[].siteType.label | string or null | Example |
rates[].rateType | object | |
rates[].rateType.id | integer or string | Example |
rates[].rateType.label | string or null | Example |
rates[].certification | object | |
rates[].certification.id | integer or string | Example |
rates[].certification.label | string or null | Example |
rates[].specialization | object | |
rates[].specialization.id | integer or string | Example |
rates[].specialization.label | string or null | Example |
rates[].assignment | boolean | The rate applies to assignments. Example |
rates[].shift | boolean | The rate applies to shifts. Example |
rates[].rate | number (float) | Example |
rates[].unit | string or null | Example |
rates[].minimumDuration | number or null | Example |
singleRates 12 fields
| Field | Type | Description |
|---|---|---|
singleRates[].serviceType | object | |
singleRates[].serviceType.id | integer or string | Example |
singleRates[].serviceType.label | string or null | Example |
singleRates[].serviceProviderType | object | |
singleRates[].serviceProviderType.id | integer or string | Example |
singleRates[].serviceProviderType.label | string or null | Example |
singleRates[].assignmentEnabled | boolean | Example |
singleRates[].assignmentRate | number (float) or null | Example |
singleRates[].assignmentRateUnit | string or null | Example |
singleRates[].shiftEnabled | boolean | Example |
singleRates[].shiftRate | number (float) or null | Example |
singleRates[].shiftRateUnit | string or null | Example |
reimbursableExpenses 2 fields
| Field | Type | Description |
|---|---|---|
reimbursableExpenses[].id | integer or string | Example |
reimbursableExpenses[].label | string or null | Example |
cancellationWindow 2 fields
| Field | Type | Description |
|---|---|---|
cancellationWindow.id | integer or string | Example |
cancellationWindow.label | string or null | Example |
paymentTerm 2 fields
| Field | Type | Description |
|---|---|---|
paymentTerm.id | integer or string | Example |
paymentTerm.label | string or null | Example |
billingFrequency 2 fields
| Field | Type | Description |
|---|---|---|
billingFrequency.id | integer or string | Example |
billingFrequency.label | string or null | Example |
invoiceFrequency 2 fields
| Field | Type | Description |
|---|---|---|
invoiceFrequency.id | integer or string | Example |
invoiceFrequency.label | string or null | Example |
invoiceSendDay 2 fields
| Field | Type | Description |
|---|---|---|
invoiceSendDay.id | integer or string | Example |
invoiceSendDay.label | string or null | Example |
proFormaSendSchedule 2 fields
| Field | Type | Description |
|---|---|---|
proFormaSendSchedule[].id | integer or string | Example |
proFormaSendSchedule[].label | string or null | Example |
documents 9 fields
| Field | Type | Description |
|---|---|---|
documents[].id | integer or null | Example |
documents[].file | string (binary) or null | The uploaded file. Omit when only the categories or tags of an existing document change. |
documents[].fileName | string or null | Example |
documents[].categories | array of object | Existing categories by |
documents[].categories[].id | integer or string | Example |
documents[].categories[].label | string or null | Example |
documents[].tags | array of object | Existing tags by |
documents[].tags[].id | integer or string | Example |
documents[].tags[].label | string or null | Example |
Example
{
"name": "Acme Health",
"clientType": {
"id": 1,
"label": "Example"
},
"email": "ops@acme.test",
"description": "string",
"logo": "string",
"isPublished": true,
"status": {
"id": 1,
"label": "Example"
},
"priority": {
"id": 1,
"label": "Example"
},
"portalAccess": false,
"networkAccess": false,
"roles": [
{
"id": 3,
"slug": "consumer",
"enabled": true
}
],
"formId": "string",
"industry": [
{
"id": 1,
"label": "Example"
}
],
"gender": {
"id": 1,
"label": "Example"
},
"hearingStatus": {
"id": 1,
"label": "Example"
},
"dateOfBirth": "string",
"internalNotes": "string",
"enableCalendarIntegration": true,
"countryCode": "+1",
"phone": "2025550101",
"phoneType": "sms_and_voice",
"phoneExtension": "204",
"videoPhoneCountryCode": "+1",
"videoPhone": "string",
"addressLine1": "123 Main St.",
"addressLine2": "string",
"city": "Dover",
"state": {
"id": 1,
"label": "Example"
},
"postalCode": "19901",
"accessInstruction": "string",
"timezone": "America/New_York",
"shiftCapacity": false,
"minimumCapacity": 0,
"maximumCapacity": 0,
"billingAddressDifferent": true,
"billingStreetAddress": "string",
"billingStreetAddressLine2": "string",
"billingCity": "string",
"billingState": {
"id": 1,
"label": "Example"
},
"billingPostalCode": "string",
"department": "string",
"contactName": "string",
"role": "string",
"contactEmail": "string",
"contactImage": "string",
"contactPhoneCountryCode": "+1",
"contactPhone": "string",
"contactPhoneType": "sms_and_voice",
"contactPhoneExtension": "string",
"contactVideoPhoneCountryCode": "+1",
"contactVideoPhone": "string",
"assignmentRequest": true,
"assignmentUpdates": true,
"allowClientsToBroadcastImmediately": true,
"receiveEmail": true,
"receiveSms": true,
"receiveInApp": true,
"defaultTimezone": "string",
"defaultLanguage": {
"id": 1,
"label": "Example"
},
"dateFormat": {
"id": 1,
"label": "Example"
},
"timeFormat": "string",
"startOfWeek": "monday",
"startOfDay": "08:00",
"endOfDay": "18:00",
"preferredServiceLocations": {
"id": 1,
"label": "Example"
},
"associatedConsumer": [
{
"consumer": {
"id": 1,
"label": "Example"
},
"relationship": {
"id": 1,
"label": "Example"
},
"portalAccess": true,
"allowServiceRequests": true,
"allowAssignmentChanges": true
}
],
"userRestricted": [
{
"id": 1,
"label": "Example"
}
],
"userPreferred": [
{
"id": 1,
"label": "Example"
}
],
"consumerRestricted": [
{
"id": 1,
"label": "Example"
}
],
"customizeRequirementPreferences": true,
"serviceTypes": [
{
"id": 1,
"label": "Example"
}
],
"serviceProviderTypes": [
{
"id": 1,
"label": "Example"
}
],
"providerTypes": [
{
"id": 1,
"label": "Example"
}
],
"skills": {
"id": 1,
"label": "Example"
},
"genderPreferences": {
"id": 1,
"label": "Example"
},
"certifications": [
{
"id": 1,
"file": "string",
"startDate": "string",
"endDate": "string"
}
],
"clearances": [
{
"id": 1,
"file": "string",
"startDate": "string",
"endDate": "string"
}
],
"specializations": [
{
"id": 1,
"label": "Example"
}
],
"restrictedClients": [
{
"id": 1,
"label": "Example"
}
],
"clientRestricted": [
{
"id": 1,
"label": "Example"
}
],
"clientLocation": {
"id": 1
},
"expenses": [
{
"id": 1,
"label": "Example"
}
],
"requirementAndPreferences": [
{
"id": 5,
"isDefault": false,
"serviceType": {
"id": 1,
"label": "Example"
},
"serviceProviderType": {
"id": 1,
"label": "Example"
},
"skill": {
"id": 1,
"label": "Example"
},
"gender": {
"id": 1,
"label": "Example"
},
"certification": [
{
"id": 1,
"label": "Example"
}
],
"clearance": [
{
"id": 1,
"label": "Example"
}
],
"specialization": [
{
"id": 1,
"label": "Example"
}
]
}
],
"customizeRateBilling": true,
"adminFee": 0,
"adminFeeMethod": "flat",
"adminFeeType": "assignment",
"rates": [
{
"id": 31,
"serviceType": {
"id": 1,
"label": "Example"
},
"serviceProviderType": {
"id": 1,
"label": "Example"
},
"siteType": {
"id": 1,
"label": "Example"
},
"rateType": {
"id": 1,
"label": "Example"
},
"certification": {
"id": 1,
"label": "Example"
},
"specialization": {
"id": 1,
"label": "Example"
},
"assignment": true,
"shift": false,
"rate": 45,
"unit": "hour",
"minimumDuration": 2
}
],
"singleRates": [
{
"serviceType": {
"id": 1,
"label": "Example"
},
"serviceProviderType": {
"id": 1,
"label": "Example"
},
"assignmentEnabled": true,
"assignmentRate": 50,
"assignmentRateUnit": "hour",
"shiftEnabled": false,
"shiftRate": 40,
"shiftRateUnit": "hour"
}
],
"reimbursableExpenses": [
{
"id": 1,
"label": "Example"
}
],
"applyCancellationFee": true,
"feeType": "full",
"feeValue": 0,
"cancellationWindow": {
"id": 1,
"label": "Example"
},
"paymentTerm": {
"id": 1,
"label": "Example"
},
"autoGenerateInvoice": true,
"autoSendInvoice": true,
"autoGenerateProForma": true,
"autoSendProForma": true,
"billingFrequency": {
"id": 1,
"label": "Example"
},
"invoiceFrequency": {
"id": 1,
"label": "Example"
},
"proFormaGroupsPerCycle": 0,
"beginBillingSchedule": "string",
"invoiceSendDay": {
"id": 1,
"label": "Example"
},
"proFormaSendSchedule": [
{
"id": 1,
"label": "Example"
}
],
"billingResponsibility": "string",
"expenseApprovalAccess": true,
"requireVerifiedTimeDocumentation": true,
"documents": [
{
"id": 12,
"file": "string",
"fileName": "intake-form.pdf",
"categories": [
{
"id": 1,
"label": "Example"
}
],
"tags": [
{
"id": 1,
"label": "Example"
}
]
}
],
"customFields": {},
"externalCustomFields": {},
"isDuplicated": false,
"duplicateId": "CLT-KBX0Q6"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/clients" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Acme Health","clientType":{"id":1,"label":"Example"},"email":"ops@acme.test","description":"string","logo":"string","isPublished":true,"status":{"id":1,"label":"Example"},"priority":{"id":1,"label":"Example"},"portalAccess":false,"networkAccess":false,"roles":[{"id":3,"slug":"consumer","enabled":true}],"formId":"string","industry":[{"id":1,"label":"Example"}],"gender":{"id":1,"label":"Example"},"hearingStatus":{"id":1,"label":"Example"},"dateOfBirth":"string","internalNotes":"string","enableCalendarIntegration":true,"countryCode":"+1","phone":"2025550101","phoneType":"sms_and_voice","phoneExtension":"204","videoPhoneCountryCode":"+1","videoPhone":"string","addressLine1":"123 Main St.","addressLine2":"string","city":"Dover","state":{"id":1,"label":"Example"},"postalCode":"19901","accessInstruction":"string","timezone":"America/New_York","shiftCapacity":false,"minimumCapacity":0,"maximumCapacity":0,"billingAddressDifferent":true,"billingStreetAddress":"string","billingStreetAddressLine2":"string","billingCity":"string","billingState":{"id":1,"label":"Example"},"billingPostalCode":"string","department":"string","contactName":"string","role":"string","contactEmail":"string","contactImage":"string","contactPhoneCountryCode":"+1","contactPhone":"string","contactPhoneType":"sms_and_voice","contactPhoneExtension":"string","contactVideoPhoneCountryCode":"+1","contactVideoPhone":"string","assignmentRequest":true,"assignmentUpdates":true,"allowClientsToBroadcastImmediately":true,"receiveEmail":true,"receiveSms":true,"receiveInApp":true,"defaultTimezone":"string","defaultLanguage":{"id":1,"label":"Example"},"dateFormat":{"id":1,"label":"Example"},"timeFormat":"string","startOfWeek":"monday","startOfDay":"08:00","endOfDay":"18:00","preferredServiceLocations":{"id":1,"label":"Example"},"associatedConsumer":[{"consumer":{"id":1,"label":"Example"},"relationship":{"id":1,"label":"Example"},"portalAccess":true,"allowServiceRequests":true,"allowAssignmentChanges":true}],"userRestricted":[{"id":1,"label":"Example"}],"userPreferred":[{"id":1,"label":"Example"}],"consumerRestricted":[{"id":1,"label":"Example"}],"customizeRequirementPreferences":true,"serviceTypes":[{"id":1,"label":"Example"}],"serviceProviderTypes":[{"id":1,"label":"Example"}],"providerTypes":[{"id":1,"label":"Example"}],"skills":{"id":1,"label":"Example"},"genderPreferences":{"id":1,"label":"Example"},"certifications":[{"id":1,"file":"string","startDate":"string","endDate":"string"}],"clearances":[{"id":1,"file":"string","startDate":"string","endDate":"string"}],"specializations":[{"id":1,"label":"Example"}],"restrictedClients":[{"id":1,"label":"Example"}],"clientRestricted":[{"id":1,"label":"Example"}],"clientLocation":{"id":1},"expenses":[{"id":1,"label":"Example"}],"requirementAndPreferences":[{"id":5,"isDefault":false,"serviceType":{"id":1,"label":"Example"},"serviceProviderType":{"id":1,"label":"Example"},"skill":{"id":1,"label":"Example"},"gender":{"id":1,"label":"Example"},"certification":[{"id":1,"label":"Example"}],"clearance":[{"id":1,"label":"Example"}],"specialization":[{"id":1,"label":"Example"}]}],"customizeRateBilling":true,"adminFee":0,"adminFeeMethod":"flat","adminFeeType":"assignment","rates":[{"id":31,"serviceType":{"id":1,"label":"Example"},"serviceProviderType":{"id":1,"label":"Example"},"siteType":{"id":1,"label":"Example"},"rateType":{"id":1,"label":"Example"},"certification":{"id":1,"label":"Example"},"specialization":{"id":1,"label":"Example"},"assignment":true,"shift":false,"rate":45,"unit":"hour","minimumDuration":2}],"singleRates":[{"serviceType":{"id":1,"label":"Example"},"serviceProviderType":{"id":1,"label":"Example"},"assignmentEnabled":true,"assignmentRate":50,"assignmentRateUnit":"hour","shiftEnabled":false,"shiftRate":40,"shiftRateUnit":"hour"}],"reimbursableExpenses":[{"id":1,"label":"Example"}],"applyCancellationFee":true,"feeType":"full","feeValue":0,"cancellationWindow":{"id":1,"label":"Example"},"paymentTerm":{"id":1,"label":"Example"},"autoGenerateInvoice":true,"autoSendInvoice":true,"autoGenerateProForma":true,"autoSendProForma":true,"billingFrequency":{"id":1,"label":"Example"},"invoiceFrequency":{"id":1,"label":"Example"},"proFormaGroupsPerCycle":0,"beginBillingSchedule":"string","invoiceSendDay":{"id":1,"label":"Example"},"proFormaSendSchedule":[{"id":1,"label":"Example"}],"billingResponsibility":"string","expenseApprovalAccess":true,"requireVerifiedTimeDocumentation":true,"documents":[{"id":12,"file":"string","fileName":"intake-form.pdf","categories":[{"id":1,"label":"Example"}],"tags":[{"id":1,"label":"Example"}]}],"customFields":{},"externalCustomFields":{},"isDuplicated":false,"duplicateId":"CLT-KBX0Q6"}'Try it
Responses
201 Client created successfully
Client created successfully
{
"success": true,
"message": "Client created successfully",
"data": {
"id": "CLT-101"
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | string | Example |
401 Not signed in
Unauthorized - Token required
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'clients:write' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
422 Validation failed
Validation error
{
"success": false,
"message": "Validation failed",
"errors": {
"name": [
"The name field is required."
],
"clientType": [
"The clientType field is required."
]
}
}Response fields (5)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.name | array of string | |
errors.clientType | array of string |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |