API reference › Preferred lists › Preferred list

Update a preference entry (notes, preferredBy, preferredUser)

PATCH /v1/preference-list/{preference_list}

Scope
settings_preferred_users:edit
Roles
admin, scheduler

Parameters

Path parameters

NameTypeDescription
preference_list requiredinteger

ID of the preference entry to update

Example 123.

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

Request body required

Any of the fields (notes, preferredBy, preferredUser) can be updated.

FieldTypeDescription
preferredByobject
preferredBy.idinteger

Example 101.

preferredBy.labelstring

Example John Doe.

preferredUserobject
preferredUser.idinteger

Example 202.

preferredUser.labelstring

Example Jane Smith.

notesstring

Optional notes (max 255 characters)

Example Updated reason for preference.

isBehalfOfOrgboolean or null

Record the entry on behalf of the organization rather than the caller. Defaults to false.

Example false.

Example

JSON
{
  "preferredBy": {
    "id": 101,
    "label": "John Doe"
  },
  "preferredUser": {
    "id": 202,
    "label": "Jane Smith"
  },
  "notes": "Updated reason for preference",
  "isBehalfOfOrg": false
}

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/preference-list/{preference_list}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"preferredBy":{"id":101,"label":"John Doe"},"preferredUser":{"id":202,"label":"Jane Smith"},"notes":"Updated reason for preference","isBehalfOfOrg":false}'

Try it

Responses

200 Preference entry updated successfully

Preference entry updated successfully

JSON
{
  "success": true,
  "message": "Preference List updated!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Preference List updated!.

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 'settings_preferred_users: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 'settings_preferred_users:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Preference entry not found

JSON
{
  "success": false,
  "message": "Preference entry not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Preference entry not found..

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 server error

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.