Permanently deletes an existing location from the organization’s location catalog.
https://api.doboard.com/{account_id}/location_delete
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 delete locations.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
session_id |
string | Yes | — | Authenticated session ID. |
location_id |
int | Yes | — | Existing location identifier to delete. |
POST /42/location_delete HTTP/1.1
Host: api.doboard.com
Content-Type: application/x-www-form-urlencoded
session_id=YOUR_SESSION_ID&location_id=7
{
"data": {
"operation_status": "SUCCESS",
"location_id": 7
}
}
location_id identifies the deleted location. 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 delete locations. |
200 |
6301 |
Location Not Found |
No location matches the supplied ID. |
200 |
6302 |
location_id is required |
Location ID was not supplied or is empty. |
200 |
0 |
Internal API Error |
The location could not be deleted. |
6301, Location Not Found.