API reference › Requests › Client portal
Create a new request
POST /v1/settings/portal/client/requests
- Scope
requests:write- Roles
- client
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
43 top-level fields; 17 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
title required | string | Example |
description required | string | Example |
requestorName required | string | Example |
requestorEmail required | string (email) | Example |
requestorPhone required | string | Example |
requestorCountryCode required | string | Example |
requestorPhoneType | string | Example |
requestorPhoneExtension | string | Example |
assignTo required | string | The only valid value — a client submitting their own portal request has no 'organization' option. One of: |
client required | object (2 nested) | |
consumer required | object (2 nested) | |
timezone required | string | Example |
originOfRequest | string | Example |
scheduleType required | string | One of: |
scheduleFrequency | string | One of: |
scheduleInterval | integer | Example |
dateTimeSlots required | array of object (9 nested) | |
status | object (2 nested) | |
rateType | object (2 nested) | |
userRestricted | array of object (2 nested) | |
userPreferred | array of object (2 nested) | |
notesToServiceProvider | string or null | Example |
internalNotes | string | Example |
submittingBehalfOfSomeone | boolean | Example |
reimbursableExpenses | array of object (2 nested) | |
allowPartialCoverage | boolean or null | Providers may cover part of the time. Defaults to false. Example |
customFields | object or null | Custom field values keyed by field id. |
documents | array of object or null (10 nested) | |
duration | number or null | Hours. Example |
externalCustomFields | object or null | Values for the external custom fields, keyed by field id. |
externalNotes | string or null | Example |
isPublished | boolean | Submit the request. False saves a draft, and relaxes most required fields. Example |
location | object (68 nested) | Where a work item happens. |
multiDay | object (10 nested) | Read when scheduleType=multi_day. |
newConsumer | object (11 nested) | Creates a new consumer inline instead of referencing an existing one. |
oneTime | object (10 nested) | Read when scheduleType=one_time. |
partialDuration | array of object or null (4 nested) | Required when allowPartialCoverage is true. |
priority | object (2 nested) | |
recurring | object (10 nested) | Read when scheduleType=recurring. |
requirementAndPreferences | array of object or null (22 nested) | skillLevel is refused in the client portal. |
signinSignoutRequired | boolean or null | Providers must sign in and out. Defaults to false. Example |
isDuplicated | boolean or null | Set when this create duplicates an existing record; records a duplication audit event instead of a plain create Example |
duplicateId | string or null | The record being duplicated. Read only with isDuplicated=true |
Nested fields
client 2 fields
| Field | Type | Description |
|---|---|---|
client.id | string | Example |
client.label | string | Example |
consumer 2 fields
| Field | Type | Description |
|---|---|---|
consumer.id | string | Example |
consumer.label | string | Example |
dateTimeSlots 9 fields
| Field | Type | Description |
|---|---|---|
dateTimeSlots[].startDate | string (date) | Example |
dateTimeSlots[].endDate | string (date) | Example |
dateTimeSlots[].timeSlots | array of object | |
dateTimeSlots[].timeSlots[].startTime | string | Example |
dateTimeSlots[].timeSlots[].endTime | string | Example |
dateTimeSlots[].scheduleFrequency | string or null | One of: |
dateTimeSlots[].scheduleInterval | integer or null | Example |
dateTimeSlots[].scheduleDays | array of string or null | Days of week this slot recurs on, when scheduleFrequency=weekly. |
dateTimeSlots[].recurrenceOption | string or null | How the recurrence ends — e.g. an end date or an occurrence count. Example |
status 2 fields
| Field | Type | Description |
|---|---|---|
status.id | integer | Example |
status.label | string | Example |
rateType 2 fields
| Field | Type | Description |
|---|---|---|
rateType.id | integer | Example |
rateType.label | string | Example |
userRestricted 2 fields
| Field | Type | Description |
|---|---|---|
userRestricted[].id | string | Example |
userRestricted[].label | string | Example |
userPreferred 2 fields
| Field | Type | Description |
|---|---|---|
userPreferred[].id | string | Example |
userPreferred[].label | string | Example |
reimbursableExpenses 2 fields
| Field | Type | Description |
|---|---|---|
reimbursableExpenses[].id | integer | Example |
reimbursableExpenses[].label | string | Example |
documents 10 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 |
documents[].isPublic | boolean or null | Visible to the client and consumer, not only to staff. Example |
location 68 fields
| Field | Type | Description |
|---|---|---|
location.locationType | string | One of: |
location.billingLocationSource | string or null | One of: |
location.billingOrganizationLocationId | string or null | Also accepted at the top level as billingOrganizationLocationId; the top-level value wins if both are sent. Example |
location.billingClientLocationId | string or null | Also accepted at the top level as billingClientLocationId; the top-level value wins if both are sent. Example |
location.billingOption | string or null | Defaults to primary. Also accepted at the top level as billingOption; the nested value wins if both are sent. Example |
location.onsite | object or null | |
location.onsite.onSiteType | string | One of: |
location.onsite.organizationLocationId | object or null | Required when onSiteType=organization. |
location.onsite.organizationLocationId.id | string | Example |
location.onsite.clientLocationId | object or null | Required when onSiteType=client and newClient is not sent. |
location.onsite.clientLocationId.id | string | Example |
location.onsite.manualLocation | object or null | Required when onSiteType=manual. Stored as sent. |
location.onsite.manualLocation.addressLine1 | string | Example |
location.onsite.manualLocation.addressLine2 | string or null | Example |
location.onsite.manualLocation.city | string | Example |
location.onsite.manualLocation.state | object | |
location.onsite.manualLocation.postalCode | string | Example |
location.onsite.manualLocation.accessInstruction | string or null | Example |
location.onsite.manualLocationContact | object or null | Required when onSiteType=manual. |
location.onsite.manualLocationContact.contactName | string | Example |
location.onsite.manualLocationContact.contactEmail | string (email) | Example |
location.onsite.manualLocationContact.contactPhone | string or null | Example |
location.onsite.manualLocationContact.contactCountryCode | string or null | Example |
location.onsite.manualLocationContact.contactPhoneType | string or null | Example |
location.onsite.manualLocationContact.contactPhoneExtension | string or null | Example |
location.onsite.manualLocationContact.videoPhone | string or null | Example |
location.onsite.manualLocationContact.videoPhoneCountryCode | string or null | Example |
location.onsite.onDemandLocationType | string or null | Required when onSiteType=ondemand. One of: |
location.onsite.onDemandLink | string or null | Example |
location.onsite.onDemandAccessInstructions | string or null | Example |
location.onsite.onDemandOrganizationLocationId | object or null | Required when onDemandLocationType=organization. |
location.onsite.onDemandOrganizationLocationId.id | string | Example |
location.onsite.onDemandClientLocationId | object or null | Required when onDemandLocationType=client. |
location.onsite.onDemandClientLocationId.id | string | Example |
location.onsite.onDemandManualLocation | object or null | Required when onDemandLocationType=manual. |
location.onsite.onDemandManualLocation.addressLine1 | string | Example |
location.onsite.onDemandManualLocation.city | string | Example |
location.onsite.onDemandManualLocation.state | object | |
location.onsite.onDemandManualLocation.postalCode | string | Example |
location.onsite.onDemandManualLocationContact | object or null | |
location.onsite.onDemandManualLocationContact.contactName | string or null | Example |
location.onsite.onDemandManualLocationContact.contactEmail | string (email) or null | Example |
location.onsite.onDemandManualLocationContact.contactPhone | string or null | Example |
location.onsite.onDemandManualLocationContact.contactCountryCode | string or null | Example |
location.onsite.serviceTypes | array of object | Required unless serviceTypeBreakdown is sent instead. |
location.onsite.serviceTypes[].id | integer | Example |
location.onsite.serviceTypeBreakdown | array of object | Per-service-type provider counts — alternative to serviceTypes when provider types are being split per service type. |
location.onsite.serviceTypeBreakdown[].serviceTypeId | integer | Example |
location.onsite.serviceTypeBreakdown[].totalProviders | integer | Example |
location.onsite.serviceTypeBreakdown[].providerTypeBreakdown | array of object | |
location.onsite.serviceProviderType | array of object or null | |
location.onsite.serviceProviderType[].id | integer | Example |
location.remote | object or null | |
location.remote.remoteType | string | One of: |
location.remote.virtualMeetingSetup | string or null | Read by consumer portal requests only. |
location.remote.meetingPlatform | string or null | Required when remoteType is not ondemand. Example |
location.remote.meetingLink | string or null | Example |
location.remote.meetingPhone | string or null | Example |
location.remote.meetingCountryCode | string or null | Example |
location.remote.meetingExtension | string or null | Example |
location.remote.accessInstruction | string or null | Example |
location.remote.onDemandLink | string or null | Example |
location.remote.onDemandAccessInstructions | string or null | Example |
location.remote.serviceTypes | array of object | |
location.remote.serviceTypes[].id | integer | Example |
location.remote.serviceTypeBreakdown | array of object | |
location.remote.serviceProviderType | array of object or null | |
location.remote.serviceProviderType[].id | integer | Example |
multiDay 10 fields
| Field | Type | Description |
|---|---|---|
multiDay.dateTimeSlots | array of object | |
multiDay.dateTimeSlots[].startDate | string (date) | Example |
multiDay.dateTimeSlots[].endDate | string (date) | Example |
multiDay.dateTimeSlots[].timeSlots | array of object | |
multiDay.dateTimeSlots[].timeSlots[].startTime | string | Example |
multiDay.dateTimeSlots[].timeSlots[].endTime | string | Example |
multiDay.dateTimeSlots[].scheduleFrequency | string or null | One of: |
multiDay.dateTimeSlots[].scheduleInterval | integer or null | Example |
multiDay.dateTimeSlots[].scheduleDays | array of string or null | Days of week this slot recurs on, when scheduleFrequency=weekly. |
multiDay.dateTimeSlots[].recurrenceOption | string or null | How the recurrence ends — e.g. an end date or an occurrence count. Example |
newConsumer 11 fields
| Field | Type | Description |
|---|---|---|
newConsumer.name | string | Example |
newConsumer.email | string (email) or null | Example |
newConsumer.phone | string or null | Example |
newConsumer.countryCode | string or null | Example |
newConsumer.phoneExtension | string or null | Example |
newConsumer.hearingStatus | object | |
newConsumer.hearingStatus.id | integer | Example |
newConsumer.communicationModes | array of object | |
newConsumer.communicationModes[].id | integer | Example |
newConsumer.preferredServiceLocations | object or null | |
newConsumer.preferredServiceLocations.id | integer | Example |
oneTime 10 fields
| Field | Type | Description |
|---|---|---|
oneTime.dateTimeSlots | array of object | |
oneTime.dateTimeSlots[].startDate | string (date) | Example |
oneTime.dateTimeSlots[].endDate | string (date) | Example |
oneTime.dateTimeSlots[].timeSlots | array of object | |
oneTime.dateTimeSlots[].timeSlots[].startTime | string | Example |
oneTime.dateTimeSlots[].timeSlots[].endTime | string | Example |
oneTime.dateTimeSlots[].scheduleFrequency | string or null | One of: |
oneTime.dateTimeSlots[].scheduleInterval | integer or null | Example |
oneTime.dateTimeSlots[].scheduleDays | array of string or null | Days of week this slot recurs on, when scheduleFrequency=weekly. |
oneTime.dateTimeSlots[].recurrenceOption | string or null | How the recurrence ends — e.g. an end date or an occurrence count. Example |
partialDuration 4 fields
| Field | Type | Description |
|---|---|---|
partialDuration[].startDate | string (date) | Example |
partialDuration[].endDate | string (date) | Example |
partialDuration[].startTime | string | Example |
partialDuration[].endTime | string | Example |
priority 2 fields
| Field | Type | Description |
|---|---|---|
priority.id | integer or string | Example |
priority.label | string or null | Example |
recurring 10 fields
| Field | Type | Description |
|---|---|---|
recurring.dateTimeSlots | array of object | |
recurring.dateTimeSlots[].startDate | string (date) | Example |
recurring.dateTimeSlots[].endDate | string (date) | Example |
recurring.dateTimeSlots[].timeSlots | array of object | |
recurring.dateTimeSlots[].timeSlots[].startTime | string | Example |
recurring.dateTimeSlots[].timeSlots[].endTime | string | Example |
recurring.dateTimeSlots[].scheduleFrequency | string or null | One of: |
recurring.dateTimeSlots[].scheduleInterval | integer or null | Example |
recurring.dateTimeSlots[].scheduleDays | array of string or null | Days of week this slot recurs on, when scheduleFrequency=weekly. |
recurring.dateTimeSlots[].recurrenceOption | string or null | How the recurrence ends — e.g. an end date or an occurrence count. Example |
requirementAndPreferences 22 fields
| Field | Type | Description |
|---|---|---|
requirementAndPreferences[].serviceType | object | |
requirementAndPreferences[].serviceType.id | integer or string | Example |
requirementAndPreferences[].serviceType.label | string or null | Example |
requirementAndPreferences[].serviceProviderCertifications | array of object | Provider type, optionally with a certification it must hold. Pairs that do not belong to the service type are skipped. |
requirementAndPreferences[].serviceProviderCertifications[].serviceProviderType | object | |
requirementAndPreferences[].serviceProviderCertifications[].serviceProviderType.id | integer or string | Example |
requirementAndPreferences[].serviceProviderCertifications[].serviceProviderType.label | string or null | Example |
requirementAndPreferences[].serviceProviderCertifications[].certifications | object | |
requirementAndPreferences[].serviceProviderCertifications[].certifications.id | integer or string | Example |
requirementAndPreferences[].serviceProviderCertifications[].certifications.label | string or null | Example |
requirementAndPreferences[].skillLevel | object | |
requirementAndPreferences[].skillLevel.id | integer or string | Example |
requirementAndPreferences[].skillLevel.label | string or null | Example |
requirementAndPreferences[].clearances | array of object | |
requirementAndPreferences[].clearances[].id | integer or string | Example |
requirementAndPreferences[].clearances[].label | string or null | Example |
requirementAndPreferences[].specializations | array of object | |
requirementAndPreferences[].specializations[].id | integer or string | Example |
requirementAndPreferences[].specializations[].label | string or null | Example |
requirementAndPreferences[].genderPreference | object | |
requirementAndPreferences[].genderPreference.id | integer or string | Example |
requirementAndPreferences[].genderPreference.label | string or null | Example |
Example
{
"title": "Goodk",
"description": "description of the assignment",
"requestorName": "John Doe",
"requestorEmail": "user@example.com",
"requestorPhone": "1234567890",
"requestorCountryCode": "+1",
"requestorPhoneType": "mobile",
"requestorPhoneExtension": "123",
"assignTo": "client",
"client": {
"id": "CLT-KBX0Q6",
"label": "Client Name"
},
"consumer": {
"id": "CSM-SQEWP0T",
"label": "Consumer Name"
},
"timezone": "America/New_York",
"originOfRequest": "client-portal",
"scheduleType": "recurring",
"scheduleFrequency": "daily",
"scheduleInterval": 2,
"dateTimeSlots": [
{
"startDate": "2024-01-01",
"endDate": "2024-01-04",
"timeSlots": [
{
"startTime": "10:00",
"endTime": "12:00"
}
],
"scheduleFrequency": "daily",
"scheduleInterval": 2,
"scheduleDays": [
"monday"
],
"recurrenceOption": "on_date"
}
],
"status": {
"id": 1,
"label": "Status Label"
},
"rateType": {
"id": 1,
"label": "Rate Type Label"
},
"userRestricted": [
{
"id": "SPR-H6OUI3",
"label": "User 1"
}
],
"userPreferred": [
{
"id": "SPR-DQRNUV",
"label": "User 1"
}
],
"notesToServiceProvider": "Reason for preference if any",
"internalNotes": "Internal notes about the assignment",
"submittingBehalfOfSomeone": true,
"reimbursableExpenses": [
{
"id": 1,
"label": "Expense 1"
}
],
"allowPartialCoverage": false,
"customFields": {},
"documents": [
{
"id": 12,
"file": "string",
"fileName": "intake-form.pdf",
"categories": [
{
"id": 1,
"label": "Example"
}
],
"tags": [
{
"id": 1,
"label": "Example"
}
],
"isPublic": false
}
],
"duration": 1.5,
"externalCustomFields": {},
"externalNotes": "Notes visible to the client and consumer",
"isPublished": true,
"location": {
"locationType": "onsite",
"billingLocationSource": "client",
"billingOrganizationLocationId": "1",
"billingClientLocationId": "1",
"billingOption": "primary",
"onsite": {
"onSiteType": "client",
"organizationLocationId": {
"id": "1"
},
"clientLocationId": {
"id": "1"
},
"manualLocation": {
"addressLine1": "123 Main St",
"addressLine2": "Suite 4",
"city": "Springfield",
"state": {
"id": 1
},
"postalCode": "12345",
"accessInstruction": "Use the side entrance"
},
"manualLocationContact": {
"contactName": "Jane Roe",
"contactEmail": "jane@example.test",
"contactPhone": "1234567890",
"contactCountryCode": "+1",
"contactPhoneType": "sms_and_voice",
"contactPhoneExtension": "123",
"videoPhone": "1234567890",
"videoPhoneCountryCode": "+1"
},
"onDemandLocationType": "organization",
"onDemandLink": "https://meet.example.test/room",
"onDemandAccessInstructions": "Dial in 5 minutes early",
"onDemandOrganizationLocationId": {
"id": "1"
},
"onDemandClientLocationId": {
"id": "1"
},
"onDemandManualLocation": {
"addressLine1": "123 Main St",
"city": "Springfield",
"state": {
"id": 1
},
"postalCode": "12345"
},
"onDemandManualLocationContact": {
"contactName": "Jane Roe",
"contactEmail": "jane@example.test",
"contactPhone": "1234567890",
"contactCountryCode": "+1"
},
"serviceTypes": [
{
"id": 1
}
],
"serviceTypeBreakdown": [
{
"serviceTypeId": 1,
"totalProviders": 2,
"providerTypeBreakdown": [
null
]
}
],
"serviceProviderType": [
{
"id": 1
}
]
},
"remote": {
"remoteType": "scheduled",
"virtualMeetingSetup": "string",
"meetingPlatform": "zoom",
"meetingLink": "https://zoom.us/j/123",
"meetingPhone": "1234567890",
"meetingCountryCode": "+1",
"meetingExtension": "123",
"accessInstruction": "Dial in 5 minutes early",
"onDemandLink": "https://meet.example.test/room",
"onDemandAccessInstructions": "Dial in 5 minutes early",
"serviceTypes": [
{
"id": 1
}
],
"serviceTypeBreakdown": [
{}
],
"serviceProviderType": [
{
"id": 1
}
]
}
},
"multiDay": {
"dateTimeSlots": [
{
"startDate": "2024-01-01",
"endDate": "2024-01-04",
"timeSlots": [
{
"startTime": "10:00",
"endTime": "12:00"
}
],
"scheduleFrequency": "daily",
"scheduleInterval": 2,
"scheduleDays": [
"monday"
],
"recurrenceOption": "on_date"
}
]
},
"newConsumer": {
"name": "Pat Doe",
"email": "pat@example.test",
"phone": "1234567890",
"countryCode": "+1",
"phoneExtension": "123",
"hearingStatus": {
"id": 1
},
"communicationModes": [
{
"id": 1
}
],
"preferredServiceLocations": {
"id": 1
}
},
"oneTime": {
"dateTimeSlots": [
{
"startDate": "2024-01-01",
"endDate": "2024-01-04",
"timeSlots": [
{
"startTime": "10:00",
"endTime": "12:00"
}
],
"scheduleFrequency": "daily",
"scheduleInterval": 2,
"scheduleDays": [
"monday"
],
"recurrenceOption": "on_date"
}
]
},
"partialDuration": [
{
"startDate": "2024-01-01",
"endDate": "2024-01-01",
"startTime": "09:00:00",
"endTime": "10:00:00"
}
],
"priority": {
"id": 1,
"label": "Example"
},
"recurring": {
"dateTimeSlots": [
{
"startDate": "2024-01-01",
"endDate": "2024-01-04",
"timeSlots": [
{
"startTime": "10:00",
"endTime": "12:00"
}
],
"scheduleFrequency": "daily",
"scheduleInterval": 2,
"scheduleDays": [
"monday"
],
"recurrenceOption": "on_date"
}
]
},
"requirementAndPreferences": [
{
"serviceType": {
"id": 1,
"label": "Example"
},
"serviceProviderCertifications": [
{
"serviceProviderType": {
"id": 1,
"label": "Example"
},
"certifications": {
"id": 1,
"label": "Example"
}
}
],
"skillLevel": {
"id": 1,
"label": "Example"
},
"clearances": [
{
"id": 1,
"label": "Example"
}
],
"specializations": [
{
"id": 1,
"label": "Example"
}
],
"genderPreference": {
"id": 1,
"label": "Example"
}
}
],
"signinSignoutRequired": false,
"isDuplicated": false,
"duplicateId": "string"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/portal/client/requests" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"title":"Goodk","description":"description of the assignment","requestorName":"John Doe","requestorEmail":"user@example.com","requestorPhone":"1234567890","requestorCountryCode":"+1","requestorPhoneType":"mobile","requestorPhoneExtension":"123","assignTo":"client","client":{"id":"CLT-KBX0Q6","label":"Client Name"},"consumer":{"id":"CSM-SQEWP0T","label":"Consumer Name"},"timezone":"America/New_York","originOfRequest":"client-portal","scheduleType":"recurring","scheduleFrequency":"daily","scheduleInterval":2,"dateTimeSlots":[{"startDate":"2024-01-01","endDate":"2024-01-04","timeSlots":[{"startTime":"10:00","endTime":"12:00"}],"scheduleFrequency":"daily","scheduleInterval":2,"scheduleDays":["monday"],"recurrenceOption":"on_date"}],"status":{"id":1,"label":"Status Label"},"rateType":{"id":1,"label":"Rate Type Label"},"userRestricted":[{"id":"SPR-H6OUI3","label":"User 1"}],"userPreferred":[{"id":"SPR-DQRNUV","label":"User 1"}],"notesToServiceProvider":"Reason for preference if any","internalNotes":"Internal notes about the assignment","submittingBehalfOfSomeone":true,"reimbursableExpenses":[{"id":1,"label":"Expense 1"}],"allowPartialCoverage":false,"customFields":{},"documents":[{"id":12,"file":"string","fileName":"intake-form.pdf","categories":[{"id":1,"label":"Example"}],"tags":[{"id":1,"label":"Example"}],"isPublic":false}],"duration":1.5,"externalCustomFields":{},"externalNotes":"Notes visible to the client and consumer","isPublished":true,"location":{"locationType":"onsite","billingLocationSource":"client","billingOrganizationLocationId":"1","billingClientLocationId":"1","billingOption":"primary","onsite":{"onSiteType":"client","organizationLocationId":{"id":"1"},"clientLocationId":{"id":"1"},"manualLocation":{"addressLine1":"123 Main St","addressLine2":"Suite 4","city":"Springfield","state":{"id":1},"postalCode":"12345","accessInstruction":"Use the side entrance"},"manualLocationContact":{"contactName":"Jane Roe","contactEmail":"jane@example.test","contactPhone":"1234567890","contactCountryCode":"+1","contactPhoneType":"sms_and_voice","contactPhoneExtension":"123","videoPhone":"1234567890","videoPhoneCountryCode":"+1"},"onDemandLocationType":"organization","onDemandLink":"https://meet.example.test/room","onDemandAccessInstructions":"Dial in 5 minutes early","onDemandOrganizationLocationId":{"id":"1"},"onDemandClientLocationId":{"id":"1"},"onDemandManualLocation":{"addressLine1":"123 Main St","city":"Springfield","state":{"id":1},"postalCode":"12345"},"onDemandManualLocationContact":{"contactName":"Jane Roe","contactEmail":"jane@example.test","contactPhone":"1234567890","contactCountryCode":"+1"},"serviceTypes":[{"id":1}],"serviceTypeBreakdown":[{"serviceTypeId":1,"totalProviders":2,"providerTypeBreakdown":[null]}],"serviceProviderType":[{"id":1}]},"remote":{"remoteType":"scheduled","virtualMeetingSetup":"string","meetingPlatform":"zoom","meetingLink":"https://zoom.us/j/123","meetingPhone":"1234567890","meetingCountryCode":"+1","meetingExtension":"123","accessInstruction":"Dial in 5 minutes early","onDemandLink":"https://meet.example.test/room","onDemandAccessInstructions":"Dial in 5 minutes early","serviceTypes":[{"id":1}],"serviceTypeBreakdown":[{}],"serviceProviderType":[{"id":1}]}},"multiDay":{"dateTimeSlots":[{"startDate":"2024-01-01","endDate":"2024-01-04","timeSlots":[{"startTime":"10:00","endTime":"12:00"}],"scheduleFrequency":"daily","scheduleInterval":2,"scheduleDays":["monday"],"recurrenceOption":"on_date"}]},"newConsumer":{"name":"Pat Doe","email":"pat@example.test","phone":"1234567890","countryCode":"+1","phoneExtension":"123","hearingStatus":{"id":1},"communicationModes":[{"id":1}],"preferredServiceLocations":{"id":1}},"oneTime":{"dateTimeSlots":[{"startDate":"2024-01-01","endDate":"2024-01-04","timeSlots":[{"startTime":"10:00","endTime":"12:00"}],"scheduleFrequency":"daily","scheduleInterval":2,"scheduleDays":["monday"],"recurrenceOption":"on_date"}]},"partialDuration":[{"startDate":"2024-01-01","endDate":"2024-01-01","startTime":"09:00:00","endTime":"10:00:00"}],"priority":{"id":1,"label":"Example"},"recurring":{"dateTimeSlots":[{"startDate":"2024-01-01","endDate":"2024-01-04","timeSlots":[{"startTime":"10:00","endTime":"12:00"}],"scheduleFrequency":"daily","scheduleInterval":2,"scheduleDays":["monday"],"recurrenceOption":"on_date"}]},"requirementAndPreferences":[{"serviceType":{"id":1,"label":"Example"},"serviceProviderCertifications":[{"serviceProviderType":{"id":1,"label":"Example"},"certifications":{"id":1,"label":"Example"}}],"skillLevel":{"id":1,"label":"Example"},"clearances":[{"id":1,"label":"Example"}],"specializations":[{"id":1,"label":"Example"}],"genderPreference":{"id":1,"label":"Example"}}],"signinSignoutRequired":false,"isDuplicated":false,"duplicateId":"string"}'Try it
Responses
201 Request created successfully
Request created successfully
{
"success": true,
"message": "Request created successfully",
"data": {
"id": "ASG-001"
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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 'requests: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 |
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
Unexpected error
{
"success": false,
"errors": "Request creation failed",
"message": "An unexpected error occurred — please try again."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |
message | string | Example |