API reference › Clients › Locations
Delete a client location
DELETE /v1/clients/{client}/locations/{location}
- Scope
clients:delete- Roles
- admin, client, scheduler
Deletes a specific client location by ID. This will remove the location and all associated data such as reimbursable expenses, rates, documents, and preferences tied to that location.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
location required | string | The ID of the client location to delete. Example |
client required | string | Unique identifier of the client Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl -X DELETE "https://api.fetchfido.ai/v1/clients/{client}/locations/{location}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Location deleted successfully
Location deleted successfully
{
"success": true,
"message": "Location deleted successfully!",
"data": {
"id": "LOC-WYZ123"
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | string | Example |
400 Bad request
Bad Request - Invalid input data
{
"success": false,
"message": "Invalid location ID provided. Ensure the ID is correct and exists."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized - Authentication required
{
"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
A client-portal caller attempted to delete a location that isn't theirs. The message is deliberately generic and does not confirm whether the location exists.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'clients:delete' 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 |
404 Not found
Not Found - Client location does not exist
{
"success": false,
"message": "Client location not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
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
Internal Server Error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |