Update notes on an assignment or shift
PATCH /v1/{type}/notes/{id}
- Scope
assignments:edit- Roles
- admin, client, scheduler, consumer
Client/consumer: updates the note to the provider, internal notes and external notes on their own link to the assignment or shift. Admin/scheduler: updates those notes on the assignment or shift itself.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
type required | string | Work item type One of: |
id required | string | Assignment or shift ID Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body
| Field | Type | Description |
|---|---|---|
notesToServiceProvider | string or null | Example |
internalNotes | string or null | Example |
externalNotes | string or null | Example |
Example
{
"notesToServiceProvider": "Please arrive 10 minutes early.",
"internalNotes": "Internal reference only.",
"externalNotes": "Visible to all parties."
}Example request
curl -X PATCH "https://api.fetchfido.ai/v1/{type}/notes/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"notesToServiceProvider":"Please arrive 10 minutes early.","internalNotes":"Internal reference only.","externalNotes":"Visible to all parties."}'Try it
Responses
200 Notes updated successfully
Notes updated successfully
{
"success": true,
"message": "Assignment notes updated successfully."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | 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
Forbidden - user does not have access to this assignment
{
"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 |
422 Validation failed
Validation error
{
"status": "error",
"message": "Unable to save. Please check the highlighted fields",
"errors": {
"name": [
"Please enter a name."
],
"email": [
"The email has already been taken."
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object | Field name to its messages. Nested keys are collapsed onto the field the form renders. |
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
Server error
{
"success": false,
"message": "An unexpected error occurred — please try again.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator. |
code | string | Always empty: the server-error response carries no error code. Example |