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.

FieldTypeDescription
title requiredstring

Example Goodk.

description requiredstring

Example description of the assignment.

requestorName requiredstring

Example John Doe.

requestorEmail requiredstring (email)

Example user@example.com.

requestorPhone requiredstring

Example 1234567890.

requestorCountryCode requiredstring

Example +1.

requestorPhoneTypestring

Example mobile.

requestorPhoneExtensionstring

Example 123.

assignTo requiredstring

The only valid value — a client submitting their own portal request has no 'organization' option.

One of: client. Example client.

client requiredobject (2 nested)
consumer requiredobject (2 nested)
timezone requiredstring

Example America/New_York.

originOfRequeststring

Example client-portal.

scheduleType requiredstring

One of: one_time, multi_day, recurring. Example recurring.

scheduleFrequencystring

One of: daily, weekly, monthly. Example daily.

scheduleIntervalinteger

Example 2.

dateTimeSlots requiredarray of object (9 nested)
statusobject (2 nested)
rateTypeobject (2 nested)
userRestrictedarray of object (2 nested)
userPreferredarray of object (2 nested)
notesToServiceProviderstring or null

Example Reason for preference if any.

internalNotesstring

Example Internal notes about the assignment.

submittingBehalfOfSomeoneboolean

Example true.

reimbursableExpensesarray of object (2 nested)
allowPartialCoverageboolean or null

Providers may cover part of the time. Defaults to false.

Example false.

customFieldsobject or null

Custom field values keyed by field id.

documentsarray of object or null (10 nested)
durationnumber or null

Hours.

Example 1.5.

externalCustomFieldsobject or null

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

externalNotesstring or null

Example Notes visible to the client and consumer.

isPublishedboolean

Submit the request. False saves a draft, and relaxes most required fields.

Example true.

locationobject (68 nested)

Where a work item happens. required rules follow isPublished; onsite and remote are read by locationType: onsite, remote, or both for hybrid.

multiDayobject (10 nested)

Read when scheduleType=multi_day.

newConsumerobject (11 nested)

Creates a new consumer inline instead of referencing an existing one.

oneTimeobject (10 nested)

Read when scheduleType=one_time.

partialDurationarray of object or null (4 nested)

Required when allowPartialCoverage is true.

priorityobject (2 nested)
recurringobject (10 nested)

Read when scheduleType=recurring.

requirementAndPreferencesarray of object or null (22 nested)

skillLevel is refused in the client portal.

signinSignoutRequiredboolean or null

Providers must sign in and out. Defaults to false.

Example false.

isDuplicatedboolean or null

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

Example false.

duplicateIdstring or null

The record being duplicated. Read only with isDuplicated=true

Nested fields

client 2 fields
FieldTypeDescription
client.idstring

Example CLT-KBX0Q6.

client.labelstring

Example Client Name.

consumer 2 fields
FieldTypeDescription
consumer.idstring

Example CSM-SQEWP0T.

consumer.labelstring

Example Consumer Name.

dateTimeSlots 9 fields
FieldTypeDescription
dateTimeSlots[].startDatestring (date)

Example 2024-01-01.

dateTimeSlots[].endDatestring (date)

Example 2024-01-04.

dateTimeSlots[].timeSlotsarray of object
dateTimeSlots[].timeSlots[].startTimestring

Example 10:00.

dateTimeSlots[].timeSlots[].endTimestring

Example 12:00.

dateTimeSlots[].scheduleFrequencystring or null

One of: daily, weekly, monthly, yearly. Example daily.

dateTimeSlots[].scheduleIntervalinteger or null

Example 2.

dateTimeSlots[].scheduleDaysarray of string or null

Days of week this slot recurs on, when scheduleFrequency=weekly.

dateTimeSlots[].recurrenceOptionstring or null

How the recurrence ends — e.g. an end date or an occurrence count.

Example on_date.

status 2 fields
FieldTypeDescription
status.idinteger

Example 1.

status.labelstring

Example Status Label.

rateType 2 fields
FieldTypeDescription
rateType.idinteger

Example 1.

rateType.labelstring

Example Rate Type Label.

userRestricted 2 fields
FieldTypeDescription
userRestricted[].idstring

Example SPR-H6OUI3.

userRestricted[].labelstring

Example User 1.

userPreferred 2 fields
FieldTypeDescription
userPreferred[].idstring

Example SPR-DQRNUV.

userPreferred[].labelstring

Example User 1.

reimbursableExpenses 2 fields
FieldTypeDescription
reimbursableExpenses[].idinteger

Example 1.

reimbursableExpenses[].labelstring

Example Expense 1.

documents 10 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.

documents[].isPublicboolean or null

Visible to the client and consumer, not only to staff.

Example false.

location 68 fields
FieldTypeDescription
location.locationTypestring

One of: onsite, remote, hybrid. Example onsite.

location.billingLocationSourcestring or null

One of: organization, client. Example client.

location.billingOrganizationLocationIdstring or null

Also accepted at the top level as billingOrganizationLocationId; the top-level value wins if both are sent.

Example 1.

location.billingClientLocationIdstring or null

Also accepted at the top level as billingClientLocationId; the top-level value wins if both are sent.

Example 1.

location.billingOptionstring or null

Defaults to primary. Also accepted at the top level as billingOption; the nested value wins if both are sent.

Example primary.

location.onsiteobject or null
location.onsite.onSiteTypestring

One of: organization, client, manual, ondemand. Example client.

location.onsite.organizationLocationIdobject or null

Required when onSiteType=organization.

location.onsite.organizationLocationId.idstring

Example 1.

location.onsite.clientLocationIdobject or null

Required when onSiteType=client and newClient is not sent.

location.onsite.clientLocationId.idstring

Example 1.

location.onsite.manualLocationobject or null

Required when onSiteType=manual. Stored as sent.

location.onsite.manualLocation.addressLine1string

Example 123 Main St.

location.onsite.manualLocation.addressLine2string or null

Example Suite 4.

location.onsite.manualLocation.citystring

Example Springfield.

location.onsite.manualLocation.stateobject
location.onsite.manualLocation.postalCodestring

Example 12345.

location.onsite.manualLocation.accessInstructionstring or null

Example Use the side entrance.

location.onsite.manualLocationContactobject or null

Required when onSiteType=manual.

location.onsite.manualLocationContact.contactNamestring

Example Jane Roe.

location.onsite.manualLocationContact.contactEmailstring (email)

Example jane@example.test.

location.onsite.manualLocationContact.contactPhonestring or null

Example 1234567890.

location.onsite.manualLocationContact.contactCountryCodestring or null

Example +1.

location.onsite.manualLocationContact.contactPhoneTypestring or null

Example sms_and_voice.

location.onsite.manualLocationContact.contactPhoneExtensionstring or null

Example 123.

location.onsite.manualLocationContact.videoPhonestring or null

Example 1234567890.

location.onsite.manualLocationContact.videoPhoneCountryCodestring or null

Example +1.

location.onsite.onDemandLocationTypestring or null

Required when onSiteType=ondemand.

One of: organization, client, manual. Example organization.

location.onsite.onDemandLinkstring or null

Example https://meet.example.test/room.

location.onsite.onDemandAccessInstructionsstring or null

Example Dial in 5 minutes early.

location.onsite.onDemandOrganizationLocationIdobject or null

Required when onDemandLocationType=organization.

location.onsite.onDemandOrganizationLocationId.idstring

Example 1.

location.onsite.onDemandClientLocationIdobject or null

Required when onDemandLocationType=client.

location.onsite.onDemandClientLocationId.idstring

Example 1.

location.onsite.onDemandManualLocationobject or null

Required when onDemandLocationType=manual.

location.onsite.onDemandManualLocation.addressLine1string

Example 123 Main St.

location.onsite.onDemandManualLocation.citystring

Example Springfield.

location.onsite.onDemandManualLocation.stateobject
location.onsite.onDemandManualLocation.postalCodestring

Example 12345.

location.onsite.onDemandManualLocationContactobject or null
location.onsite.onDemandManualLocationContact.contactNamestring or null

Example Jane Roe.

location.onsite.onDemandManualLocationContact.contactEmailstring (email) or null

Example jane@example.test.

location.onsite.onDemandManualLocationContact.contactPhonestring or null

Example 1234567890.

location.onsite.onDemandManualLocationContact.contactCountryCodestring or null

Example +1.

location.onsite.serviceTypesarray of object

Required unless serviceTypeBreakdown is sent instead.

location.onsite.serviceTypes[].idinteger

Example 1.

location.onsite.serviceTypeBreakdownarray of object

Per-service-type provider counts — alternative to serviceTypes when provider types are being split per service type.

location.onsite.serviceTypeBreakdown[].serviceTypeIdinteger

Example 1.

location.onsite.serviceTypeBreakdown[].totalProvidersinteger

Example 2.

location.onsite.serviceTypeBreakdown[].providerTypeBreakdownarray of object
location.onsite.serviceProviderTypearray of object or null
location.onsite.serviceProviderType[].idinteger

Example 1.

location.remoteobject or null
location.remote.remoteTypestring

One of: ondemand, scheduled. Example scheduled.

location.remote.virtualMeetingSetupstring or null

Read by consumer portal requests only.

location.remote.meetingPlatformstring or null

Required when remoteType is not ondemand.

Example zoom.

location.remote.meetingLinkstring or null

Example https://zoom.us/j/123.

location.remote.meetingPhonestring or null

Example 1234567890.

location.remote.meetingCountryCodestring or null

Example +1.

location.remote.meetingExtensionstring or null

Example 123.

location.remote.accessInstructionstring or null

Example Dial in 5 minutes early.

location.remote.onDemandLinkstring or null

Example https://meet.example.test/room.

location.remote.onDemandAccessInstructionsstring or null

Example Dial in 5 minutes early.

location.remote.serviceTypesarray of object
location.remote.serviceTypes[].idinteger

Example 1.

location.remote.serviceTypeBreakdownarray of object
location.remote.serviceProviderTypearray of object or null
location.remote.serviceProviderType[].idinteger

Example 1.

multiDay 10 fields
FieldTypeDescription
multiDay.dateTimeSlotsarray of object
multiDay.dateTimeSlots[].startDatestring (date)

Example 2024-01-01.

multiDay.dateTimeSlots[].endDatestring (date)

Example 2024-01-04.

multiDay.dateTimeSlots[].timeSlotsarray of object
multiDay.dateTimeSlots[].timeSlots[].startTimestring

Example 10:00.

multiDay.dateTimeSlots[].timeSlots[].endTimestring

Example 12:00.

multiDay.dateTimeSlots[].scheduleFrequencystring or null

One of: daily, weekly, monthly, yearly. Example daily.

multiDay.dateTimeSlots[].scheduleIntervalinteger or null

Example 2.

multiDay.dateTimeSlots[].scheduleDaysarray of string or null

Days of week this slot recurs on, when scheduleFrequency=weekly.

multiDay.dateTimeSlots[].recurrenceOptionstring or null

How the recurrence ends — e.g. an end date or an occurrence count.

Example on_date.

newConsumer 11 fields
FieldTypeDescription
newConsumer.namestring

Example Pat Doe.

newConsumer.emailstring (email) or null

Example pat@example.test.

newConsumer.phonestring or null

Example 1234567890.

newConsumer.countryCodestring or null

Example +1.

newConsumer.phoneExtensionstring or null

Example 123.

newConsumer.hearingStatusobject
newConsumer.hearingStatus.idinteger

Example 1.

newConsumer.communicationModesarray of object
newConsumer.communicationModes[].idinteger

Example 1.

newConsumer.preferredServiceLocationsobject or null
newConsumer.preferredServiceLocations.idinteger

Example 1.

oneTime 10 fields
FieldTypeDescription
oneTime.dateTimeSlotsarray of object
oneTime.dateTimeSlots[].startDatestring (date)

Example 2024-01-01.

oneTime.dateTimeSlots[].endDatestring (date)

Example 2024-01-04.

oneTime.dateTimeSlots[].timeSlotsarray of object
oneTime.dateTimeSlots[].timeSlots[].startTimestring

Example 10:00.

oneTime.dateTimeSlots[].timeSlots[].endTimestring

Example 12:00.

oneTime.dateTimeSlots[].scheduleFrequencystring or null

One of: daily, weekly, monthly, yearly. Example daily.

oneTime.dateTimeSlots[].scheduleIntervalinteger or null

Example 2.

oneTime.dateTimeSlots[].scheduleDaysarray of string or null

Days of week this slot recurs on, when scheduleFrequency=weekly.

oneTime.dateTimeSlots[].recurrenceOptionstring or null

How the recurrence ends — e.g. an end date or an occurrence count.

Example on_date.

partialDuration 4 fields
FieldTypeDescription
partialDuration[].startDatestring (date)

Example 2024-01-01.

partialDuration[].endDatestring (date)

Example 2024-01-01.

partialDuration[].startTimestring

Example 09:00:00.

partialDuration[].endTimestring

Example 10:00:00.

priority 2 fields
FieldTypeDescription
priority.idinteger or string

Example 1.

priority.labelstring or null

Example Example.

recurring 10 fields
FieldTypeDescription
recurring.dateTimeSlotsarray of object
recurring.dateTimeSlots[].startDatestring (date)

Example 2024-01-01.

recurring.dateTimeSlots[].endDatestring (date)

Example 2024-01-04.

recurring.dateTimeSlots[].timeSlotsarray of object
recurring.dateTimeSlots[].timeSlots[].startTimestring

Example 10:00.

recurring.dateTimeSlots[].timeSlots[].endTimestring

Example 12:00.

recurring.dateTimeSlots[].scheduleFrequencystring or null

One of: daily, weekly, monthly, yearly. Example daily.

recurring.dateTimeSlots[].scheduleIntervalinteger or null

Example 2.

recurring.dateTimeSlots[].scheduleDaysarray of string or null

Days of week this slot recurs on, when scheduleFrequency=weekly.

recurring.dateTimeSlots[].recurrenceOptionstring or null

How the recurrence ends — e.g. an end date or an occurrence count.

Example on_date.

requirementAndPreferences 22 fields
FieldTypeDescription
requirementAndPreferences[].serviceTypeobject
requirementAndPreferences[].serviceType.idinteger or string

Example 1.

requirementAndPreferences[].serviceType.labelstring or null

Example Example.

requirementAndPreferences[].serviceProviderCertificationsarray of object

Provider type, optionally with a certification it must hold. Pairs that do not belong to the service type are skipped.

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

Example 1.

requirementAndPreferences[].serviceProviderCertifications[].serviceProviderType.labelstring or null

Example Example.

requirementAndPreferences[].serviceProviderCertifications[].certificationsobject
requirementAndPreferences[].serviceProviderCertifications[].certifications.idinteger or string

Example 1.

requirementAndPreferences[].serviceProviderCertifications[].certifications.labelstring or null

Example Example.

requirementAndPreferences[].skillLevelobject
requirementAndPreferences[].skillLevel.idinteger or string

Example 1.

requirementAndPreferences[].skillLevel.labelstring or null

Example Example.

requirementAndPreferences[].clearancesarray of object
requirementAndPreferences[].clearances[].idinteger or string

Example 1.

requirementAndPreferences[].clearances[].labelstring or null

Example Example.

requirementAndPreferences[].specializationsarray of object
requirementAndPreferences[].specializations[].idinteger or string

Example 1.

requirementAndPreferences[].specializations[].labelstring or null

Example Example.

requirementAndPreferences[].genderPreferenceobject
requirementAndPreferences[].genderPreference.idinteger or string

Example 1.

requirementAndPreferences[].genderPreference.labelstring or null

Example Example.

Example

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

Shell
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

JSON
{
  "success": true,
  "message": "Request created successfully",
  "data": {
    "id": "ASG-001"
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Request created successfully.

dataobject
data.idstring

Example ASG-001.

401 Not signed in

Missing, invalid or expired API key.

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 'requests: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 'requests:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

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

Unexpected error

JSON
{
  "success": false,
  "errors": "Request creation failed",
  "message": "An unexpected error occurred — please try again."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Request creation failed.

messagestring

Example An unexpected error occurred — please try again..