API reference › Clients › Locations in the client portal
Update an existing client location in client portal
POST /v1/settings/portal/client/location/{id}
- Scope
clients:write- Roles
- client
Updates a client location in client portal.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | The ID of the client location to update Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
40 top-level fields; 5 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
name required | string | Example |
description | string or null | Example |
addressLine1 | string | Example |
addressLine2 | string or null | Example |
city | string | Example |
state | string | Example |
postalCode | string | Example |
accessInstruction | string or null | Example |
isPrimaryAddress | boolean | Example |
shiftCapacity | boolean or null | Example |
minimumCapacity | integer or null | Example |
maximumCapacity | integer or null | Example |
timezone | string or null | Example |
status | object (2 nested) | |
isPublished | boolean | Example |
department | string | Example |
contactName | string | Example |
role | string or null | Example |
contactEmail | string (email) | Example |
contactPhone | string or null | Example |
contactPhoneType | string or null | One of: |
reimbursableExpenses | array of object or null (2 nested) | |
billingAddressDifferent | boolean or null | Bill to the address below instead of the main address. Example |
billingStreetAddress | string or null | Example |
billingStreetAddressLine2 | string or null | Example |
billingCity | string or null | Example |
billingState | object (2 nested) | |
billingPostalCode | string or null | Example |
contactImage | string (binary) or null | Contact person photo. Send an empty value to remove the current one. |
contactPhoneExtension | string or null | Example |
customFields | object or null | Custom field values keyed by field id. |
externalCustomFields | object or null | Values for the external custom fields, keyed by field id. |
documents | array of object (9 nested) | |
internalNotes | string or null | Example |
logo | string (binary) or null | Image file. |
videoPhone | string or null | Example |
contactVideoPhone | string or null | Location contact video phone. |
priority | object or null (2 nested) | Default priority for work at this location. |
videoPhoneCountryCode | string or null | Example |
countryCode | string or null | Contact phone country code Example |
Nested fields
status 2 fields
| Field | Type | Description |
|---|---|---|
status.id | integer | Example |
status.label | string | Example |
reimbursableExpenses 2 fields
| Field | Type | Description |
|---|---|---|
reimbursableExpenses[].id | integer | Example |
reimbursableExpenses[].label | string | Example |
billingState 2 fields
| Field | Type | Description |
|---|---|---|
billingState.id | integer or string | Example |
billingState.label | string or null | Example |
documents 9 fields
| Field | Type | Description |
|---|---|---|
documents[].id | integer or null | Example |
documents[].file | string (binary) or null | The uploaded file. Omit when only the categories or tags of an existing document change. |
documents[].fileName | string or null | Example |
documents[].categories | array of object | Existing categories by |
documents[].categories[].id | integer or string | Example |
documents[].categories[].label | string or null | Example |
documents[].tags | array of object | Existing tags by |
documents[].tags[].id | integer or string | Example |
documents[].tags[].label | string or null | Example |
priority 2 fields
| Field | Type | Description |
|---|---|---|
priority.id | integer or string | Example |
priority.label | string or null | Example |
Example
{
"name": "Acme East Coast Office",
"description": "Primary location for Eastern US operations.",
"addressLine1": "456 Industrial Rd",
"addressLine2": "Building B",
"city": "Philadelphia",
"state": "PA",
"postalCode": "19103",
"accessInstruction": "Enter through Gate 3. Use intercom for access.",
"isPrimaryAddress": false,
"shiftCapacity": true,
"minimumCapacity": 5,
"maximumCapacity": 20,
"timezone": "EST",
"status": {
"id": 1,
"label": "Active"
},
"isPublished": false,
"department": "Operations",
"contactName": "Jane Doe",
"role": "Operations Manager",
"contactEmail": "jane.doe@acme.com",
"contactPhone": "+11234567896",
"contactPhoneType": "sms_and_voice",
"reimbursableExpenses": [
{
"id": 6,
"label": "example1"
}
],
"billingAddressDifferent": false,
"billingStreetAddress": "12 Main St",
"billingStreetAddressLine2": "Suite 4",
"billingCity": "Dover",
"billingState": {
"id": 1,
"label": "Example"
},
"billingPostalCode": "19901",
"contactImage": "string",
"contactPhoneExtension": "204",
"customFields": {},
"externalCustomFields": {},
"documents": [
{
"id": 12,
"file": "string",
"fileName": "intake-form.pdf",
"categories": [
{
"id": 1,
"label": "Example"
}
],
"tags": [
{
"id": 1,
"label": "Example"
}
]
}
],
"internalNotes": "Gate code 1234",
"logo": "string",
"videoPhone": "9888888888",
"contactVideoPhone": "string",
"priority": {
"id": 1,
"label": "Example"
},
"videoPhoneCountryCode": "+1",
"countryCode": "+1"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/portal/client/location/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Acme East Coast Office","description":"Primary location for Eastern US operations.","addressLine1":"456 Industrial Rd","addressLine2":"Building B","city":"Philadelphia","state":"PA","postalCode":"19103","accessInstruction":"Enter through Gate 3. Use intercom for access.","isPrimaryAddress":false,"shiftCapacity":true,"minimumCapacity":5,"maximumCapacity":20,"timezone":"EST","status":{"id":1,"label":"Active"},"isPublished":false,"department":"Operations","contactName":"Jane Doe","role":"Operations Manager","contactEmail":"jane.doe@acme.com","contactPhone":"+11234567896","contactPhoneType":"sms_and_voice","reimbursableExpenses":[{"id":6,"label":"example1"}],"billingAddressDifferent":false,"billingStreetAddress":"12 Main St","billingStreetAddressLine2":"Suite 4","billingCity":"Dover","billingState":{"id":1,"label":"Example"},"billingPostalCode":"19901","contactImage":"string","contactPhoneExtension":"204","customFields":{},"externalCustomFields":{},"documents":[{"id":12,"file":"string","fileName":"intake-form.pdf","categories":[{"id":1,"label":"Example"}],"tags":[{"id":1,"label":"Example"}]}],"internalNotes":"Gate code 1234","logo":"string","videoPhone":"9888888888","contactVideoPhone":"string","priority":{"id":1,"label":"Example"},"videoPhoneCountryCode":"+1","countryCode":"+1"}'Try it
Responses
200 Client location updated successfully
Client location updated successfully
{
"success": true,
"message": "Location Updated!",
"data": {
"id": 42
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
401 Not signed in
Unauthorized - Token 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
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'clients:write' 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 |
422 Validation failed
Validation error. Includes any org-owned location setting sent by the client, refused when present, even as null or empty: adminFee, adminFeeMethod, adminFeeType, singleRates, rates, client, requireVerifiedTimeDocumentation.
{
"success": false,
"message": "Validation failed",
"errors": {
"name": [
"The name field is required."
],
"addressLine1": [
"The address line 1 field is required."
],
"city": [
"The city field is required."
],
"status.id": [
"The status.id field must be an integer."
],
"contactEmail": [
"The contact email must be a valid email address."
]
}
}Response fields (8)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.name | array of string | |
errors.addressLine1 | array of string | |
errors.city | array of string | |
errors.status.id | array of string | |
errors.contactEmail | array of string |
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 |