API reference › Organization locations

Set a default organization location

PUT /v1/set-default-location/{id}

Scope
settings_locations:edit
Roles
admin, scheduler

Sets the specified organization location as the default location for the organization.

Parameters

Path parameters

NameTypeDescription
id requiredstring

The ID of the organization location to set as default (e.g. ORGLOC-MBQA3)

Example ORGLOC-MBQA3.

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

Example request

Shell
curl -X PUT "https://api.fetchfido.ai/v1/set-default-location/{id}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Default location updated successfully

Default location updated successfully

JSON
{
  "success": true,
  "message": "Default location updated successfully",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Default location updated successfully.

datastring or null
400 Bad request

Validation or business logic error

JSON
{
  "success": false,
  "message": "Cannot set unpublished location as default.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Cannot set unpublished location as default..

datastring or null
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_locations: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_locations:edit' 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": "An unexpected error occurred — please try again.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

datastring or null