Update an existing assignment
POST /v1/assignments/{id}
- Scope
assignments:edit- Roles
- admin, scheduler
Carries several distinct actions as payload variations rather than separate endpoints, which is what a tool catalog needs to know to map them:
- Reschedule — send
dateTimeSlots(withscheduleType, andscheduleFrequencywhen recurring). There is no separate reschedule endpoint; changing the slots *is* the reschedule. - Broadcast vs direct assignment —
assignmentMethod:directassigns the named providers,broadcastoffers the assignment to the eligible pool. UsebroadcastAudienceto narrow that pool. - Cancel — NOT done here. Use POST /assignment/cancel-assignment, which requires
reasonForCancellationalongside the id and start date/time. There is no start/stop-broadcast action on this endpoint or any other: broadcast state (off/active/onhold) advances through the assignment lifecycle and the scheduled timeout and escalation commands, not through a direct call.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | ID of the assignment to be updated Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
69 top-level fields; 32 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
title | string or null | Example |
description | string or null | Example |
isPublished | boolean or null | Example |
duration | number or null | Hours — used when setting location.onsite/remote slot capacity. Example |
allowPointOfContact | string or null | One of: |
requestorName | string or null | Example |
requestorEmail | string (email) or null | Example |
requestorPhone | string or null | Example |
requestorCountryCode | string or null | Example |
requestorPhoneType | string or null | One of: |
requestorPhoneExtension | string or null | Example |
requestorConsumer | object or null (1 nested) | |
assignTo | string or null | One of: |
billTo | string or null | One of: |
client | object or null (2 nested) | |
newClient | object or null (14 nested) | Creates a new client inline instead of using an existing one — alternative to client. Prohibited on a request-type assignment unless the same payload approves the request (requestStatus.id). |
consumer | array of object or null (2 nested) | Consumers on the assignment. A single object is also accepted and treated as a one-item list. |
newConsumer | object or null (9 nested) | |
location | object or null (54 nested) | Required (locationType) when isPublished=true and the assignment has no stored location. Changing locationType away from one with assigned providers is rejected. |
billingOrganizationLocationId | string or null | Example |
billingClientLocationId | string or null | Example |
billingOption | string or null | Example |
timezone | string or null | Example |
scheduleType | string or null | One of: |
oneTime | object or null (10 nested) | Read only when scheduleType=one_time. Changing dateTimeSlots on a completed/past/canceled assignment with no linked finance documents is rejected. |
multiDay | object or null (10 nested) | Read only when scheduleType=multi_day. Same restriction as oneTime. |
recurring | object or null (10 nested) | Read only when scheduleType=recurring. Same restriction as oneTime. |
priority | object or null (2 nested) | |
status | object or null (2 nested) | Prohibited on a request-type assignment unless the same payload approves the request. Terminal once in the canceled tree. Away from completed/final/past is restricted to No-Show or Canceled. |
requestStatus | object or null (2 nested) | Setting this to the 'approved' status id converts a request into a real assignment (and its child requests), allowing client/newClient/status/assignProviders in the same payload. |
requestNotApprovedReason | string or null | Example |
rateType | object or null (2 nested) | |
broadcast | object or null (2 nested) | |
broadcastNotify | boolean or null | Example |
broadcastAudience | array of object or null (1 nested) | |
userRestricted | array of object or null (2 nested) | |
userPreferred | array of object or null (2 nested) | |
notesToServiceProvider | string or null | Example |
internalNotes | string or null | Example |
externalNotes | string or null | Example |
allowPartialCoverage | boolean or null | Example |
partialDuration | array of object or null (4 nested) | Partial coverage windows (required when allowPartialCoverage is true). Omit to keep the assignment's existing windows. |
assignmentMethod | string or null | One of: |
enableBroadcastBestMatch | boolean or null | Example |
assignProviders | array of object or null (7 nested) | Omit to keep the assignment's currently assigned providers. |
overrideSingleRate | boolean or null | Example |
overrideBufferTime | boolean or null | Example |
overrideClientPreference | boolean or null | Example |
clientPreferences | object (8 nested) | Which of the client's stored requirements and preferences the scheduler overrode on this work item. Each flag set to true means that kind is overridden. Stored as sent. |
overrideConsumerPreferences | boolean or null | Accepted, but not currently saved on update. Example |
consumerPreferences | object (8 nested) | The same override flags for the consumer's stored requirements and preferences. Stored as sent. |
overrideServiceProviderPreference | boolean or null | Example |
serviceProviderPreferences | object (12 nested) | Provider-side rules the scheduler overrode on this work item. Stored as sent. |
requireVerifiedTimeDocumentation | boolean or null | Example |
reimbursableExpenses | array of object or null (2 nested) | |
providerExpenses | array of object or null (17 nested) | Provider expenses. |
invoiceStatus | object or null (1 nested) | |
payStatus | object or null (1 nested) | |
estimatedCost | object or null | Client-calculated rate preview. Saving is skipped on a completed/past assignment unless the slot time actually changed or finance documents are already linked. |
requirementAndPreferences | array of object or null (22 nested) | Ignored when quickAssignment is true; the quick flow builds the rows from quickServiceTypes and quickServiceProviderTypes. |
quickAssignment | boolean or null | Rebuild requirements from quickServiceTypes and quickServiceProviderTypes. Example |
quickServiceTypes | array of object or null (1 nested) | |
quickServiceProviderTypes | array of object or null (1 nested) | |
customFields | object or null | Omitted fields are carried forward from what is already stored, so a partial edit never wipes previously saved custom field values. |
externalCustomFields | object or null | Values for the external custom fields, keyed by field id. |
documents | array of object or null (3 nested) | |
affectFinancials | boolean or null | When a no-show finance sync fails, true re-throws the error instead of saving the no-show selection silently. |
noshowStatusReason | array of object or null (8 nested) | Required when status is being set to a No-Show status. Every participant not named here is cleared of their no-show flag. |
cancellationDetails | object (7 nested) | cancellationReason/cancellationCausedBy/billableForCancellation/billCancellationClient/payCancellationProvider are also accepted flat at the top level; the nested value under cancellationDetails wins if both are sent. |
Nested fields
requestorConsumer 1 fields
| Field | Type | Description |
|---|---|---|
requestorConsumer.id | string | Example |
client 2 fields
| Field | Type | Description |
|---|---|---|
client.id | string | Example |
client.label | string | Example |
newClient 14 fields
| Field | Type | Description |
|---|---|---|
newClient.name | string | Example |
newClient.email | string (email) | Example |
newClient.contactName | string | Example |
newClient.contactPhone | string or null | Example |
newClient.contactPhoneCountryCode | string or null | Example |
newClient.contactPhoneType | string or null | Example |
newClient.videoPhone | string or null | Example |
newClient.videoPhoneCountryCode | string or null | Example |
newClient.phoneExtension | string or null | Example |
newClient.addressLine1 | string | Example |
newClient.city | string | Example |
newClient.state | object | |
newClient.state.id | integer | Example |
newClient.postalCode | string | Example |
consumer 2 fields
| Field | Type | Description |
|---|---|---|
consumer[].id | string | Example |
consumer[].label | string | Example |
newConsumer 9 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 |
location 54 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 | |
location.onsite.organizationLocationId.id | string | Example |
location.onsite.clientLocationId | object or null | |
location.onsite.clientLocationId.id | string | Example |
location.onsite.manualLocation | object or null | |
location.onsite.manualLocation.addressLine1 | string | Example |
location.onsite.manualLocation.city | string | Example |
location.onsite.manualLocation.state | object | |
location.onsite.manualLocation.postalCode | string | Example |
location.onsite.manualLocationContact | object or null | |
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.videoPhone | string or null | Example |
location.onsite.manualLocationContact.videoPhoneCountryCode | string or null | Example |
location.onsite.onDemandLocationType | string or null | One of: |
location.onsite.onDemandLink | string or null | Example |
location.onsite.onDemandAccessInstructions | string or null | Example |
location.onsite.onDemandOrganizationLocationId | object or null | |
location.onsite.onDemandOrganizationLocationId.id | string | Example |
location.onsite.onDemandClientLocationId | object or null | |
location.onsite.onDemandClientLocationId.id | string | Example |
location.onsite.onDemandManualLocation | object or null | |
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.serviceTypes | array of object | Removing a provider type that already has assigned providers is rejected (see location.onsite.serviceTypeBreakdown). |
location.onsite.serviceTypes[].id | integer | Example |
location.onsite.serviceTypeBreakdown | array of object | Reducing totalProviders below the number of providers already assigned to that provider type is rejected. |
location.onsite.serviceTypeBreakdown[].serviceTypeId | integer | Example |
location.onsite.serviceTypeBreakdown[].totalProviders | integer | Example |
location.onsite.serviceTypeBreakdown[].providerTypeBreakdown | array of object | |
location.remote | object or null | |
location.remote.remoteType | string | One of: |
location.remote.meetingPlatform | string or null | 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 |
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 |
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 |
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 |
priority 2 fields
| Field | Type | Description |
|---|---|---|
priority.id | integer | Example |
priority.label | string | Example |
status 2 fields
| Field | Type | Description |
|---|---|---|
status.id | integer | Example |
status.label | string | Example |
requestStatus 2 fields
| Field | Type | Description |
|---|---|---|
requestStatus.id | integer | Example |
requestStatus.label | string | Example |
rateType 2 fields
| Field | Type | Description |
|---|---|---|
rateType.id | integer | Example |
rateType.label | string | Example |
broadcast 2 fields
| Field | Type | Description |
|---|---|---|
broadcast.id | string | Example |
broadcast.label | string | Example |
broadcastAudience 1 fields
| Field | Type | Description |
|---|---|---|
broadcastAudience[].id | 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 |
partialDuration 4 fields
| Field | Type | Description |
|---|---|---|
partialDuration[].startDate | string (date) | Example |
partialDuration[].endDate | string (date) | Example |
partialDuration[].startTime | string | Example |
partialDuration[].endTime | string | Example |
assignProviders 7 fields
| Field | Type | Description |
|---|---|---|
assignProviders[].id | string | Example |
assignProviders[].serviceType | integer | Example |
assignProviders[].locationType | string | One of: |
assignProviders[].serviceProviderType | integer or null | Provider type the provider fills. Inferred when the service type has only one. Example |
assignProviders[].partialReason | string or null | Why a partly matching provider was assigned anyway. |
assignProviders[].notAvailableReason | string or null | Why an unavailable provider was assigned anyway. |
assignProviders[].visibilityReason | string or null | How the provider came to be listed. Defaults to partial_match_allowed when partialReason is sent, else full_match. Example |
clientPreferences 8 fields
| Field | Type | Description |
|---|---|---|
clientPreferences.clearance | boolean or null | |
clientPreferences.skill | boolean or null | |
clientPreferences.certifications | boolean or null | |
clientPreferences.specialization | boolean or null | |
clientPreferences.gender | boolean or null | |
clientPreferences.restrictedServiceProvider | boolean or null | |
clientPreferences.restrictedConsumers | boolean or null | |
clientPreferences.preferredServiceProvider | boolean or null |
consumerPreferences 8 fields
| Field | Type | Description |
|---|---|---|
consumerPreferences.clearance | boolean or null | |
consumerPreferences.skill | boolean or null | |
consumerPreferences.certifications | boolean or null | |
consumerPreferences.specialization | boolean or null | |
consumerPreferences.gender | boolean or null | |
consumerPreferences.restrictedServiceProvider | boolean or null | |
consumerPreferences.restrictedClients | boolean or null | |
consumerPreferences.preferredServiceProvider | boolean or null |
serviceProviderPreferences 12 fields
| Field | Type | Description |
|---|---|---|
serviceProviderPreferences.overrideBufferTime | boolean or null | |
serviceProviderPreferences.onSite | boolean or null | |
serviceProviderPreferences.remote | boolean or null | |
serviceProviderPreferences.assignmentLimits | boolean or null | |
serviceProviderPreferences.availability | boolean or null | |
serviceProviderPreferences.locationDistance | boolean or null | |
serviceProviderPreferences.restrictedConsumers | boolean or null | |
serviceProviderPreferences.restrictedClients | boolean or null | |
serviceProviderPreferences.restrictedServiceProviders | boolean or null | |
serviceProviderPreferences.preferredConsumers | boolean or null | |
serviceProviderPreferences.preferredClients | boolean or null | |
serviceProviderPreferences.preferredServiceProviders | boolean or null |
reimbursableExpenses 2 fields
| Field | Type | Description |
|---|---|---|
reimbursableExpenses[].id | integer | Example |
reimbursableExpenses[].label | string | Example |
providerExpenses 17 fields
| Field | Type | Description |
|---|---|---|
providerExpenses[].entityId | string or null | Work item the expenses belong to (ASG-* or SFT-*). Defaults to the work item being saved. Example |
providerExpenses[].providerId required | string | Example |
providerExpenses[].expenses | array of object | |
providerExpenses[].expenses[].id | integer or null | Existing expense id to update; omit to create. Example |
providerExpenses[].expenses[].name required | string | Example |
providerExpenses[].expenses[].amount | number or null | min 0.01. Example |
providerExpenses[].expenses[].expense | number or null | Unit amount, multiplied by quantity. min 0.01. Example |
providerExpenses[].expenses[].quantity | number or null | min 0.01. Example |
providerExpenses[].expenses[].billTo | string or null | One of: |
providerExpenses[].expenses[].document | string (binary) or null | Receipt: pdf, jpg, jpeg or png, max 2 MB. |
providerExpenses[].expenses[].isDefault | boolean or null | |
providerExpenses[].expenses[].reimbursement_basic | string or null | Reimbursement basis of a freeform custom expense. One of: |
providerExpenses[].expenses[].expenseType | string or null | One of: |
providerExpenses[].expenses[].rate | number or null | Required when reimbursement_basic is percentage. min 0. |
providerExpenses[].expenses[].sourceReimbursableExpense | object | Catalog category a custom line is seeded from. |
providerExpenses[].expenses[].sourceReimbursableExpense.id | integer or string | Example |
providerExpenses[].expenses[].sourceReimbursableExpense.label | string or null | Example |
invoiceStatus 1 fields
| Field | Type | Description |
|---|---|---|
invoiceStatus.id | string | Example |
payStatus 1 fields
| Field | Type | Description |
|---|---|---|
payStatus.id | string | 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 |
quickServiceTypes 1 fields
| Field | Type | Description |
|---|---|---|
quickServiceTypes[].id | integer | Example |
quickServiceProviderTypes 1 fields
| Field | Type | Description |
|---|---|---|
quickServiceProviderTypes[].id | integer | Example |
documents 3 fields
| Field | Type | Description |
|---|---|---|
documents[].id | integer or null | Existing document id — omit file when updating an existing document's metadata only. |
documents[].file | string (binary) | Required unless id is sent. |
documents[].fileName | string | Example |
noshowStatusReason 8 fields
| Field | Type | Description |
|---|---|---|
noshowStatusReason[].clients | array of object | |
noshowStatusReason[].clients[].id | string | Example |
noshowStatusReason[].clients[].noShowFee | number or null | Example |
noshowStatusReason[].consumers | array of object | |
noshowStatusReason[].consumers[].id | string | Example |
noshowStatusReason[].providers | array of object | |
noshowStatusReason[].providers[].id | string | Example |
noshowStatusReason[].reason | string | Example |
cancellationDetails 7 fields
| Field | Type | Description |
|---|---|---|
cancellationDetails.cancellationReason | string | Example |
cancellationDetails.cancellationCausedBy | string or object | Who caused the cancellation, as a label or a {id, label} object. |
cancellationDetails.cancellationCausedByClient | object or array of object | The client or clients responsible, when the cause is a client: one {id, label} or a list. |
cancellationDetails.cancellationCausedByProvider | object or array of object | The provider or providers responsible, when the cause is a provider: one {id, label} or a list. |
cancellationDetails.billableForCancellation | boolean | Example |
cancellationDetails.billCancellationClient | boolean | When billableForCancellation is true, at least one of billCancellationClient/payCancellationProvider must also be true. Example |
cancellationDetails.payCancellationProvider | boolean | Example |
Example
{
"title": "Special interpreter — intake appointment",
"description": "description of the assignment",
"isPublished": true,
"duration": 1.5,
"allowPointOfContact": "client_poc",
"requestorName": "John Doe",
"requestorEmail": "user@example.com",
"requestorPhone": "1234567890",
"requestorCountryCode": "+1",
"requestorPhoneType": "sms_and_voice",
"requestorPhoneExtension": "123",
"requestorConsumer": {
"id": "CSM-SQEWP0T"
},
"assignTo": "client",
"billTo": "clients",
"client": {
"id": "CLT-KBX0Q6",
"label": "Client Name"
},
"newClient": {
"name": "Acme Corp",
"email": "contact@acme.test",
"contactName": "Jane Roe",
"contactPhone": "1234567890",
"contactPhoneCountryCode": "+1",
"contactPhoneType": "sms_and_voice",
"videoPhone": "1234567890",
"videoPhoneCountryCode": "+1",
"phoneExtension": "123",
"addressLine1": "123 Main St",
"city": "Springfield",
"state": {
"id": 1
},
"postalCode": "12345"
},
"consumer": [
{
"id": "CSM-SQEWP0T",
"label": "Consumer Name"
}
],
"newConsumer": {
"name": "Pat Doe",
"email": "pat@example.test",
"phone": "1234567890",
"countryCode": "+1",
"phoneExtension": "123",
"hearingStatus": {
"id": 1
},
"communicationModes": [
{
"id": 1
}
]
},
"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",
"city": "Springfield",
"state": {
"id": 1
},
"postalCode": "12345"
},
"manualLocationContact": {
"contactName": "Jane Roe",
"contactEmail": "jane@example.test",
"contactPhone": "1234567890",
"contactCountryCode": "+1",
"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"
},
"serviceTypes": [
{
"id": 1
}
],
"serviceTypeBreakdown": [
{
"serviceTypeId": 1,
"totalProviders": 2,
"providerTypeBreakdown": [
null
]
}
]
},
"remote": {
"remoteType": "scheduled",
"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": [
{}
]
}
},
"billingOrganizationLocationId": "1",
"billingClientLocationId": "1",
"billingOption": "primary",
"timezone": "America/New_York",
"scheduleType": "recurring",
"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"
}
]
},
"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"
}
]
},
"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"
}
]
},
"priority": {
"id": 1,
"label": "Priority Label"
},
"status": {
"id": 1,
"label": "Status Label"
},
"requestStatus": {
"id": 1,
"label": "Request Status Label"
},
"requestNotApprovedReason": "Requested provider is unavailable for this window.",
"rateType": {
"id": 1,
"label": "Rate Type Label"
},
"broadcast": {
"id": "on",
"label": "On"
},
"broadcastNotify": true,
"broadcastAudience": [
{
"id": "SPR-H6OUI3"
}
],
"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",
"externalNotes": "Notes visible to the client/consumer",
"allowPartialCoverage": true,
"partialDuration": [
{
"startDate": "2024-01-01",
"endDate": "2024-01-01",
"startTime": "09:00",
"endTime": "10:00"
}
],
"assignmentMethod": "direct",
"enableBroadcastBestMatch": true,
"assignProviders": [
{
"id": "SPR-H6OUI3",
"serviceType": 1,
"locationType": "onsite",
"serviceProviderType": 2,
"partialReason": "string",
"notAvailableReason": "string",
"visibilityReason": "client_selected"
}
],
"overrideSingleRate": true,
"overrideBufferTime": true,
"overrideClientPreference": true,
"clientPreferences": {
"clearance": true,
"skill": true,
"certifications": true,
"specialization": true,
"gender": true,
"restrictedServiceProvider": true,
"restrictedConsumers": true,
"preferredServiceProvider": true
},
"overrideConsumerPreferences": true,
"consumerPreferences": {
"clearance": true,
"skill": true,
"certifications": true,
"specialization": true,
"gender": true,
"restrictedServiceProvider": true,
"restrictedClients": true,
"preferredServiceProvider": true
},
"overrideServiceProviderPreference": true,
"serviceProviderPreferences": {
"overrideBufferTime": true,
"onSite": true,
"remote": true,
"assignmentLimits": true,
"availability": true,
"locationDistance": true,
"restrictedConsumers": true,
"restrictedClients": true,
"restrictedServiceProviders": true,
"preferredConsumers": true,
"preferredClients": true,
"preferredServiceProviders": true
},
"requireVerifiedTimeDocumentation": false,
"reimbursableExpenses": [
{
"id": 1,
"label": "Expense 1"
}
],
"providerExpenses": [
{
"entityId": "ASG-SA2IVL",
"providerId": "SPR-H6OUI3",
"expenses": [
{
"id": 42,
"name": "Parking",
"amount": 12.5,
"expense": 12.5,
"quantity": 1,
"billTo": "organization",
"document": "string",
"isDefault": true,
"reimbursement_basic": "per_unit",
"expenseType": "travel",
"rate": 0,
"sourceReimbursableExpense": {
"id": 1,
"label": "Example"
}
}
]
}
],
"invoiceStatus": {
"id": "pending"
},
"payStatus": {
"id": "pending"
},
"estimatedCost": {},
"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"
}
}
],
"quickAssignment": false,
"quickServiceTypes": [
{
"id": 1
}
],
"quickServiceProviderTypes": [
{
"id": 1
}
],
"customFields": {},
"externalCustomFields": {},
"documents": [
{
"id": 0,
"file": "string",
"fileName": "intake-form.pdf"
}
],
"affectFinancials": true,
"noshowStatusReason": [
{
"clients": [
{
"id": "CLT-KBX0Q6",
"noShowFee": 50
}
],
"consumers": [
{
"id": "CSM-SQEWP0T"
}
],
"providers": [
{
"id": "SPR-H6OUI3"
}
],
"reason": "Did not attend"
}
],
"cancellationDetails": {
"cancellationReason": "Client requested cancellation",
"cancellationCausedBy": "client",
"cancellationCausedByClient": {
"id": 1,
"label": "Example"
},
"cancellationCausedByProvider": {
"id": 1,
"label": "Example"
},
"billableForCancellation": true,
"billCancellationClient": true,
"payCancellationProvider": false
}
}Example request
curl -X POST "https://api.fetchfido.ai/v1/assignments/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"title":"Special interpreter — intake appointment","description":"description of the assignment","isPublished":true,"duration":1.5,"allowPointOfContact":"client_poc","requestorName":"John Doe","requestorEmail":"user@example.com","requestorPhone":"1234567890","requestorCountryCode":"+1","requestorPhoneType":"sms_and_voice","requestorPhoneExtension":"123","requestorConsumer":{"id":"CSM-SQEWP0T"},"assignTo":"client","billTo":"clients","client":{"id":"CLT-KBX0Q6","label":"Client Name"},"newClient":{"name":"Acme Corp","email":"contact@acme.test","contactName":"Jane Roe","contactPhone":"1234567890","contactPhoneCountryCode":"+1","contactPhoneType":"sms_and_voice","videoPhone":"1234567890","videoPhoneCountryCode":"+1","phoneExtension":"123","addressLine1":"123 Main St","city":"Springfield","state":{"id":1},"postalCode":"12345"},"consumer":[{"id":"CSM-SQEWP0T","label":"Consumer Name"}],"newConsumer":{"name":"Pat Doe","email":"pat@example.test","phone":"1234567890","countryCode":"+1","phoneExtension":"123","hearingStatus":{"id":1},"communicationModes":[{"id":1}]},"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","city":"Springfield","state":{"id":1},"postalCode":"12345"},"manualLocationContact":{"contactName":"Jane Roe","contactEmail":"jane@example.test","contactPhone":"1234567890","contactCountryCode":"+1","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"},"serviceTypes":[{"id":1}],"serviceTypeBreakdown":[{"serviceTypeId":1,"totalProviders":2,"providerTypeBreakdown":[null]}]},"remote":{"remoteType":"scheduled","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":[{}]}},"billingOrganizationLocationId":"1","billingClientLocationId":"1","billingOption":"primary","timezone":"America/New_York","scheduleType":"recurring","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"}]},"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"}]},"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"}]},"priority":{"id":1,"label":"Priority Label"},"status":{"id":1,"label":"Status Label"},"requestStatus":{"id":1,"label":"Request Status Label"},"requestNotApprovedReason":"Requested provider is unavailable for this window.","rateType":{"id":1,"label":"Rate Type Label"},"broadcast":{"id":"on","label":"On"},"broadcastNotify":true,"broadcastAudience":[{"id":"SPR-H6OUI3"}],"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","externalNotes":"Notes visible to the client/consumer","allowPartialCoverage":true,"partialDuration":[{"startDate":"2024-01-01","endDate":"2024-01-01","startTime":"09:00","endTime":"10:00"}],"assignmentMethod":"direct","enableBroadcastBestMatch":true,"assignProviders":[{"id":"SPR-H6OUI3","serviceType":1,"locationType":"onsite","serviceProviderType":2,"partialReason":"string","notAvailableReason":"string","visibilityReason":"client_selected"}],"overrideSingleRate":true,"overrideBufferTime":true,"overrideClientPreference":true,"clientPreferences":{"clearance":true,"skill":true,"certifications":true,"specialization":true,"gender":true,"restrictedServiceProvider":true,"restrictedConsumers":true,"preferredServiceProvider":true},"overrideConsumerPreferences":true,"consumerPreferences":{"clearance":true,"skill":true,"certifications":true,"specialization":true,"gender":true,"restrictedServiceProvider":true,"restrictedClients":true,"preferredServiceProvider":true},"overrideServiceProviderPreference":true,"serviceProviderPreferences":{"overrideBufferTime":true,"onSite":true,"remote":true,"assignmentLimits":true,"availability":true,"locationDistance":true,"restrictedConsumers":true,"restrictedClients":true,"restrictedServiceProviders":true,"preferredConsumers":true,"preferredClients":true,"preferredServiceProviders":true},"requireVerifiedTimeDocumentation":false,"reimbursableExpenses":[{"id":1,"label":"Expense 1"}],"providerExpenses":[{"entityId":"ASG-SA2IVL","providerId":"SPR-H6OUI3","expenses":[{"id":42,"name":"Parking","amount":12.5,"expense":12.5,"quantity":1,"billTo":"organization","document":"string","isDefault":true,"reimbursement_basic":"per_unit","expenseType":"travel","rate":0,"sourceReimbursableExpense":{"id":1,"label":"Example"}}]}],"invoiceStatus":{"id":"pending"},"payStatus":{"id":"pending"},"estimatedCost":{},"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"}}],"quickAssignment":false,"quickServiceTypes":[{"id":1}],"quickServiceProviderTypes":[{"id":1}],"customFields":{},"externalCustomFields":{},"documents":[{"id":0,"file":"string","fileName":"intake-form.pdf"}],"affectFinancials":true,"noshowStatusReason":[{"clients":[{"id":"CLT-KBX0Q6","noShowFee":50}],"consumers":[{"id":"CSM-SQEWP0T"}],"providers":[{"id":"SPR-H6OUI3"}],"reason":"Did not attend"}],"cancellationDetails":{"cancellationReason":"Client requested cancellation","cancellationCausedBy":"client","cancellationCausedByClient":{"id":1,"label":"Example"},"cancellationCausedByProvider":{"id":1,"label":"Example"},"billableForCancellation":true,"billCancellationClient":true,"payCancellationProvider":false}}'Try it
Responses
200 Assignment updated successfully
Assignment updated successfully
{
"success": true,
"message": "Assignment updated successfully",
"data": {
"id": "ASG-SA2IVL",
"messages": [
"string"
],
"workItemFinancialsOutOfSync": true,
"noShowFinanceSync": {}
}
}Response fields (7)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | The main message; varies by what changed (e.g. a request-approval conversion message). Example |
data | object | |
data.id | string | Example |
data.messages | array of string | Secondary notices about the save (e.g. providers that could not be re-attached). |
data.workItemFinancialsOutOfSync | boolean or null | Present when affectFinancials=false was sent but the change actually affects billed amounts. |
data.noShowFinanceSync | object or null | Present when a no-show selection changed. |
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 'assignments:edit' 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": "Assignment updation 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 |