API reference › Clients

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.

FieldTypeDescription
name requiredstring

max length 255. Example Acme Health.

clientType requiredobject (2 nested)

Required on create.

emailstring (email) or null

Required when portalAccess or networkAccess is true. Unique among clients.

max length 255. Example ops@acme.test.

descriptionstring or null

min length 5, max length 2000.

logostring (binary) or null

jpg, jpeg or png, max 2 MB.

isPublishedboolean or null

Example true.

statusobject (2 nested)
priorityobject (2 nested)
portalAccessboolean or null

Let the client sign in to the client portal.

Example false.

networkAccessboolean or null

Share the client with the Fido network.

Example false.

rolesarray of object or null (3 nested)
formIdstring or null

Intake form the client came from.

industryarray of object or null (2 nested)
genderobject (2 nested)
hearingStatusobject (2 nested)
dateOfBirthstring (date) or null
internalNotesstring or null

min length 2, max length 2000.

enableCalendarIntegrationboolean or null
countryCodestring or null

max length 5. Example +1.

phonestring or null

Required when receiveSms is true.

max length 20. Example 2025550101.

phoneTypestring or null

One of: sms_and_voice, voice_only. Example sms_and_voice.

phoneExtensionstring or null

max length 10. Example 204.

videoPhoneCountryCodestring or null

max length 5. Example +1.

videoPhonestring or null

max length 20.

addressLine1string or null

Primary location address.

max length 255. Example 123 Main St..

addressLine2string or null

max length 255.

citystring or null

max length 100. Example Dover.

stateobject (2 nested)
postalCodestring or null

12345 or 12345-6789.

Example 19901.

accessInstructionstring or null
timezonestring or null

Example America/New_York.

shiftCapacityboolean or null

Example false.

minimumCapacityinteger or null

Required when shiftCapacity is true; at most maximumCapacity.

min 0.

maximumCapacityinteger or null

Required when shiftCapacity is true; at least minimumCapacity.

min 1.

billingAddressDifferentboolean or null
billingStreetAddressstring or null
billingStreetAddressLine2string or null
billingCitystring or null
billingStateobject (2 nested)
billingPostalCodestring or null
departmentstring or null

Primary location contact.

max length 255.

contactNamestring or null

max length 255.

rolestring or null

max length 255.

contactEmailstring (email) or null

max length 255.

contactImagestring (binary) or null

jpg, jpeg, png or gif, max 2 MB.

contactPhoneCountryCodestring or null

Example +1.

contactPhonestring or null

Required when receiveSms is true.

contactPhoneTypestring or null

One of: sms_and_voice, voice_only.

contactPhoneExtensionstring or null
contactVideoPhoneCountryCodestring or null

Example +1.

contactVideoPhonestring or null
assignmentRequestboolean or null

Notification preference.

assignmentUpdatesboolean or null

Notification preference.

allowClientsToBroadcastImmediatelyboolean or null

The client's requests broadcast without scheduler review.

receiveEmailboolean or null

Notification preference.

receiveSmsboolean or null

Notification preference.

receiveInAppboolean or null

Notification preference.

defaultTimezonestring or null

Localization.

defaultLanguageobject (2 nested)

Localization.

dateFormatobject (2 nested)

Localization.

timeFormatstring or null

Localization.

startOfWeekstring or null

Localization.

Example monday.

startOfDaystring or null

Localization.

Example 08:00.

endOfDaystring or null

Localization.

Example 18:00.

preferredServiceLocationsobject (2 nested)

Localization.

associatedConsumerarray of object or null (9 nested)

Consumers associated with the client.

userRestrictedarray of object or null (2 nested)
userPreferredarray of object or null (2 nested)
consumerRestrictedarray of object or null (2 nested)
customizeRequirementPreferencesboolean or null

Per-service-type requirements. true reads requirementAndPreferences; false reads the flat default-tier fields below.

serviceTypesarray of object or null (2 nested)

Default requirement tier. Service types.

serviceProviderTypesarray of object or null (2 nested)

Default requirement tier. Provider roles.

providerTypesarray of object or null (2 nested)

Default requirement tier. Provider types.

skillsobject or null (2 nested)

Default requirement tier. Minimum skill level.

genderPreferencesobject or null (2 nested)

Default requirement tier. Preferred provider gender.

certificationsarray of object or null (4 nested)

Default requirement tier. Required certifications.

clearancesarray of object or null (4 nested)

Default requirement tier. Required clearances.

specializationsarray of object or null (2 nested)

Default requirement tier. Required specializations.

restrictedClientsarray of object or null (2 nested)

Clients this client may not be scheduled with.

clientRestrictedarray of object or null (2 nested)

Client users restricted from this client.

clientLocationobject or null (1 nested)

Existing client location to attach this client to.

expensesarray of object or null (2 nested)

Reimbursable expense categories enabled for this client.

requirementAndPreferencesarray of object or null (23 nested)
customizeRateBillingboolean or null

Use the client's own rates and billing instead of the organization defaults. Makes billingFrequency and invoiceFrequency required.

adminFeenumber or null
adminFeeMethodstring or null

Example flat.

adminFeeTypestring or null

One of: assignment, shift, both.

ratesarray of object or null (24 nested)
singleRatesarray of object or null (12 nested)
reimbursableExpensesarray of object or null (2 nested)
applyCancellationFeeboolean or null
feeTypestring or null

Required when applyCancellationFee is true. full clears feeValue.

One of: full, flat, percentage.

feeValuenumber or null

min 0.

cancellationWindowobject (2 nested)

Required when applyCancellationFee is true.

paymentTermobject (2 nested)
autoGenerateInvoiceboolean or null
autoSendInvoiceboolean or null
autoGenerateProFormaboolean or null
autoSendProFormaboolean or null
billingFrequencyobject (2 nested)
invoiceFrequencyobject (2 nested)
proFormaGroupsPerCycleinteger or null

Required with billingFrequency or invoiceFrequency.

min 1, max 12.

beginBillingSchedulestring (date) or null

Required with billingFrequency or invoiceFrequency.

invoiceSendDayobject (2 nested)

Required with billingFrequency or invoiceFrequency.

proFormaSendSchedulearray of object or null (2 nested)

Required with billingFrequency or invoiceFrequency.

billingResponsibilitystring or null
expenseApprovalAccessboolean or null
requireVerifiedTimeDocumentationboolean or null
documentsarray of object or null (9 nested)

pdf, doc, docx, xls, xlsx, csv, png or jpg, max 2 MB each.

customFieldsobject or null

Custom field values keyed by field id.

externalCustomFieldsobject or null

Values for the external custom fields, keyed by field id.

isDuplicatedboolean or null

Set when this create duplicates an existing client; records a duplication audit event instead of a plain create.

Example false.

duplicateIdstring or null

The client being duplicated. Read only with isDuplicated=true.

Example CLT-KBX0Q6.

Nested fields

clientType 2 fields
FieldTypeDescription
clientType.idinteger or string

Example 1.

clientType.labelstring or null

Example Example.

status 2 fields
FieldTypeDescription
status.idinteger or string

Example 1.

status.labelstring or null

Example Example.

priority 2 fields
FieldTypeDescription
priority.idinteger or string

Example 1.

priority.labelstring or null

Example Example.

roles 3 fields
FieldTypeDescription
roles[].idinteger or null

Role id. Resolved from slug when omitted.

Example 3.

roles[].slugstring

Example consumer.

roles[].enabledboolean

Example true.

industry 2 fields
FieldTypeDescription
industry[].idinteger or string

Example 1.

industry[].labelstring or null

Example Example.

gender 2 fields
FieldTypeDescription
gender.idinteger or string

Example 1.

gender.labelstring or null

Example Example.

hearingStatus 2 fields
FieldTypeDescription
hearingStatus.idinteger or string

Example 1.

hearingStatus.labelstring or null

Example Example.

state 2 fields
FieldTypeDescription
state.idinteger or string

Example 1.

state.labelstring or null

Example Example.

billingState 2 fields
FieldTypeDescription
billingState.idinteger or string

Example 1.

billingState.labelstring or null

Example Example.

defaultLanguage 2 fields
FieldTypeDescription
defaultLanguage.idinteger or string

Example 1.

defaultLanguage.labelstring or null

Example Example.

dateFormat 2 fields
FieldTypeDescription
dateFormat.idinteger or string

Example 1.

dateFormat.labelstring or null

Example Example.

preferredServiceLocations 2 fields
FieldTypeDescription
preferredServiceLocations.idinteger or string

Example 1.

preferredServiceLocations.labelstring or null

Example Example.

associatedConsumer 9 fields
FieldTypeDescription
associatedConsumer[].consumerobject
associatedConsumer[].consumer.idinteger or string

Example 1.

associatedConsumer[].consumer.labelstring or null

Example Example.

associatedConsumer[].relationshipobject
associatedConsumer[].relationship.idinteger or string

Example 1.

associatedConsumer[].relationship.labelstring or null

Example Example.

associatedConsumer[].portalAccessboolean or null
associatedConsumer[].allowServiceRequestsboolean or null
associatedConsumer[].allowAssignmentChangesboolean or null
userRestricted 2 fields
FieldTypeDescription
userRestricted[].idinteger or string

Example 1.

userRestricted[].labelstring or null

Example Example.

userPreferred 2 fields
FieldTypeDescription
userPreferred[].idinteger or string

Example 1.

userPreferred[].labelstring or null

Example Example.

consumerRestricted 2 fields
FieldTypeDescription
consumerRestricted[].idinteger or string

Example 1.

consumerRestricted[].labelstring or null

Example Example.

serviceTypes 2 fields
FieldTypeDescription
serviceTypes[].idinteger or string

Example 1.

serviceTypes[].labelstring or null

Example Example.

serviceProviderTypes 2 fields
FieldTypeDescription
serviceProviderTypes[].idinteger or string

Example 1.

serviceProviderTypes[].labelstring or null

Example Example.

providerTypes 2 fields
FieldTypeDescription
providerTypes[].idinteger or string

Example 1.

providerTypes[].labelstring or null

Example Example.

skills 2 fields
FieldTypeDescription
skills.idinteger or string

Example 1.

skills.labelstring or null

Example Example.

genderPreferences 2 fields
FieldTypeDescription
genderPreferences.idinteger or string

Example 1.

genderPreferences.labelstring or null

Example Example.

certifications 4 fields
FieldTypeDescription
certifications[].id requiredinteger or string

Example 1.

certifications[].filestring (binary) or null

Supporting document.

certifications[].startDatestring (date) or null
certifications[].endDatestring (date) or null
clearances 4 fields
FieldTypeDescription
clearances[].id requiredinteger or string

Example 1.

clearances[].filestring (binary) or null

Supporting document.

clearances[].startDatestring (date) or null
clearances[].endDatestring (date) or null
specializations 2 fields
FieldTypeDescription
specializations[].idinteger or string

Example 1.

specializations[].labelstring or null

Example Example.

restrictedClients 2 fields
FieldTypeDescription
restrictedClients[].idinteger or string

Example 1.

restrictedClients[].labelstring or null

Example Example.

clientRestricted 2 fields
FieldTypeDescription
clientRestricted[].idinteger or string

Example 1.

clientRestricted[].labelstring or null

Example Example.

clientLocation 1 fields
FieldTypeDescription
clientLocation.idinteger or string

Example 1.

expenses 2 fields
FieldTypeDescription
expenses[].id requiredinteger or string

Example 1.

expenses[].labelstring or null

Example Example.

requirementAndPreferences 23 fields
FieldTypeDescription
requirementAndPreferences[].idinteger or null

Example 5.

requirementAndPreferences[].isDefaultboolean

Example false.

requirementAndPreferences[].serviceTypeobject
requirementAndPreferences[].serviceType.idinteger or string

Example 1.

requirementAndPreferences[].serviceType.labelstring or null

Example Example.

requirementAndPreferences[].serviceProviderTypeobject
requirementAndPreferences[].serviceProviderType.idinteger or string

Example 1.

requirementAndPreferences[].serviceProviderType.labelstring or null

Example Example.

requirementAndPreferences[].skillobject
requirementAndPreferences[].skill.idinteger or string

Example 1.

requirementAndPreferences[].skill.labelstring or null

Example Example.

requirementAndPreferences[].genderobject
requirementAndPreferences[].gender.idinteger or string

Example 1.

requirementAndPreferences[].gender.labelstring or null

Example Example.

requirementAndPreferences[].certificationarray of object
requirementAndPreferences[].certification[].idinteger or string

Example 1.

requirementAndPreferences[].certification[].labelstring or null

Example Example.

requirementAndPreferences[].clearancearray of object
requirementAndPreferences[].clearance[].idinteger or string

Example 1.

requirementAndPreferences[].clearance[].labelstring or null

Example Example.

requirementAndPreferences[].specializationarray of object
requirementAndPreferences[].specialization[].idinteger or string

Example 1.

requirementAndPreferences[].specialization[].labelstring or null

Example Example.

rates 24 fields
FieldTypeDescription
rates[].idinteger or null

Example 31.

rates[].serviceTypeobject
rates[].serviceType.idinteger or string

Example 1.

rates[].serviceType.labelstring or null

Example Example.

rates[].serviceProviderTypeobject
rates[].serviceProviderType.idinteger or string

Example 1.

rates[].serviceProviderType.labelstring or null

Example Example.

rates[].siteTypeobject
rates[].siteType.idinteger or string

Example 1.

rates[].siteType.labelstring or null

Example Example.

rates[].rateTypeobject
rates[].rateType.idinteger or string

Example 1.

rates[].rateType.labelstring or null

Example Example.

rates[].certificationobject
rates[].certification.idinteger or string

Example 1.

rates[].certification.labelstring or null

Example Example.

rates[].specializationobject
rates[].specialization.idinteger or string

Example 1.

rates[].specialization.labelstring or null

Example Example.

rates[].assignmentboolean

The rate applies to assignments.

Example true.

rates[].shiftboolean

The rate applies to shifts.

Example false.

rates[].ratenumber (float)

Example 45.

rates[].unitstring or null

Example hour.

rates[].minimumDurationnumber or null

Example 2.

singleRates 12 fields
FieldTypeDescription
singleRates[].serviceTypeobject
singleRates[].serviceType.idinteger or string

Example 1.

singleRates[].serviceType.labelstring or null

Example Example.

singleRates[].serviceProviderTypeobject
singleRates[].serviceProviderType.idinteger or string

Example 1.

singleRates[].serviceProviderType.labelstring or null

Example Example.

singleRates[].assignmentEnabledboolean

Example true.

singleRates[].assignmentRatenumber (float) or null

Example 50.

singleRates[].assignmentRateUnitstring or null

Example hour.

singleRates[].shiftEnabledboolean

Example false.

singleRates[].shiftRatenumber (float) or null

Example 40.

singleRates[].shiftRateUnitstring or null

Example hour.

reimbursableExpenses 2 fields
FieldTypeDescription
reimbursableExpenses[].idinteger or string

Example 1.

reimbursableExpenses[].labelstring or null

Example Example.

cancellationWindow 2 fields
FieldTypeDescription
cancellationWindow.idinteger or string

Example 1.

cancellationWindow.labelstring or null

Example Example.

paymentTerm 2 fields
FieldTypeDescription
paymentTerm.idinteger or string

Example 1.

paymentTerm.labelstring or null

Example Example.

billingFrequency 2 fields
FieldTypeDescription
billingFrequency.idinteger or string

Example 1.

billingFrequency.labelstring or null

Example Example.

invoiceFrequency 2 fields
FieldTypeDescription
invoiceFrequency.idinteger or string

Example 1.

invoiceFrequency.labelstring or null

Example Example.

invoiceSendDay 2 fields
FieldTypeDescription
invoiceSendDay.idinteger or string

Example 1.

invoiceSendDay.labelstring or null

Example Example.

proFormaSendSchedule 2 fields
FieldTypeDescription
proFormaSendSchedule[].idinteger or string

Example 1.

proFormaSendSchedule[].labelstring or null

Example Example.

documents 9 fields
FieldTypeDescription
documents[].idinteger or null

Example 12.

documents[].filestring (binary) or null

The uploaded file. Omit when only the categories or tags of an existing document change.

documents[].fileNamestring or null

Example intake-form.pdf.

documents[].categoriesarray of object

Existing categories by id, or new ones by label.

documents[].categories[].idinteger or string

Example 1.

documents[].categories[].labelstring or null

Example Example.

documents[].tagsarray of object

Existing tags by id, or new ones by label.

documents[].tags[].idinteger or string

Example 1.

documents[].tags[].labelstring or null

Example Example.

Example

JSON
{
  "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

Shell
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

JSON
{
  "success": true,
  "message": "Client created successfully",
  "data": {
    "id": "CLT-101"
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Client created successfully.

dataobject
data.idstring

Example CLT-101.

401 Not signed in

Unauthorized - Token required

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'clients:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error

JSON
{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "name": [
      "The name field is required."
    ],
    "clientType": [
      "The clientType field is required."
    ]
  }
}
Response fields (5)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation failed.

errorsobject
errors.namearray of string
errors.clientTypearray of string
429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..