API reference › Assignments

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

NameTypeDescription
type requiredstring

Work item type

One of: assignment, shift. Example assignment.

id requiredstring

Assignment or shift ID

Example ASG-J5A17Q.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body

FieldTypeDescription
notesToServiceProviderstring or null

Example Please arrive 10 minutes early..

internalNotesstring or null

Example Internal reference only..

externalNotesstring or null

Example Visible to all parties..

Example

JSON
{
  "notesToServiceProvider": "Please arrive 10 minutes early.",
  "internalNotes": "Internal reference only.",
  "externalNotes": "Visible to all parties."
}

Example request

Shell
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

JSON
{
  "success": true,
  "message": "Assignment notes updated successfully."
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment notes updated successfully..

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

Forbidden - user does not have access to this assignment

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

Example false.

messagestring

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error

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

Example error.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsobject

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.

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

Server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsstring or null

Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator.

codestring

Always empty: the server-error response carries no error code.

Example .