API reference › Preferred lists › Preferred list

Create a new preference entry

POST /v1/preference-list

Scope
settings_preferred_users:write
Roles
admin, scheduler

Parameters

None of its own.

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

Request body required

FieldTypeDescription
preferredBy requiredobject
preferredBy.id requiredstring

ID of the user adding the preference

Example CLT-EDFFGJ.

preferredBy.label requiredstring

Role of the user adding the preference

Example Client.

preferredUser requiredobject
preferredUser.id requiredstring

ID of the user being preferred

Example SPR-EDUHU.

preferredUser.label requiredstring

Role of the user being preferred

Example Service Provider.

notesstring

Optional notes for this preference

Example Demo.

isBehalfOfOrgboolean or null

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

Example false.

Example

JSON
{
  "preferredBy": {
    "id": "CLT-EDFFGJ",
    "label": "Client"
  },
  "preferredUser": {
    "id": "SPR-EDUHU",
    "label": "Service Provider"
  },
  "notes": "Demo",
  "isBehalfOfOrg": false
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/preference-list" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"preferredBy":{"id":"CLT-EDFFGJ","label":"Client"},"preferredUser":{"id":"SPR-EDUHU","label":"Service Provider"},"notes":"Demo","isBehalfOfOrg":false}'

Try it

Responses

201 Preference successfully created

Preference successfully created

JSON
{
  "success": true,
  "message": "John Doe has been added to preferences by Jane Smith."
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example John Doe has been added to preferences by Jane Smith..

400 Bad request

Validation error

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields.",
  "errors": {
    "preferredUser": [
      "You can only prefer a Service Provider."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields..

errorsobject
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: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 'settings_preferred_users: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 server error

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Preference list creation failed: [error details]."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

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

Example Preference list creation failed: [error details]..