Changes the name or codes of an existing location.
https://api.doboard.com/{account_id}/location_update
account_id is the numeric organization identifier.
GET, POST. POST accepts parameters as application/x-www-form-urlencoded.
Requires a valid session_id. Only ADMIN and PROJECT_MANAGER users can update locations.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
session_id |
string | Yes | — | Authenticated session ID. |
location_id |
int | Yes | — | Existing location identifier. |
location_name |
string | No | Unchanged | Location name. Truncated to the first 64 characters. |
country_code |
string | No | Unchanged | Country code. Truncated to the first 2 characters. |
location_code |
string | No | Unchanged | Short location code. Truncated to the first 3 characters. |
Supply at least one editable field: location_name, country_code or location_code.
Omitted fields remain unchanged. An explicitly supplied empty string clears the corresponding field.
Change the name and short code:
POST /42/location_update HTTP/1.1
Host: api.doboard.com
Content-Type: application/x-www-form-urlencoded
session_id=YOUR_SESSION_ID&location_id=7&location_name=London+Office&location_code=LDN
Clear the short code:
POST /42/location_update HTTP/1.1
Host: api.doboard.com
Content-Type: application/x-www-form-urlencoded
session_id=YOUR_SESSION_ID&location_id=7&location_code=
{
"data": {
"operation_status": "SUCCESS",
"location_id": 7
}
}
The ID in this example is illustrative.
| HTTP Code | error_no |
Message | Description |
|---|---|---|---|
401 |
401 |
session_id Unknown |
Missing or invalid session. |
403 |
403 |
Permission denied |
The user cannot update locations. |
200 |
6201 |
Location Not Found |
No location matches the supplied ID. |
200 |
6202 |
location_id is required |
Location ID was not supplied or is empty. |
200 |
0 |
Internal API Error |
The location could not be updated. |