Delete a project
Request, parameters, response and errors of DELETE /v1/projects/{externalProjectId}.
Last updated:
Removes a project that has no units. A project with units is refused with 409 project_not_empty: release them with POST /projects/{externalProjectId}/unassign or delete their listings first. The listings of a project are never deleted with it. Emits project.updated; the event's object is { object: "project", id, deleted: true }. Needs write access to projects.
Requires the scope propose and at least the level write on projects.
Request
DELETE https://api.athaus.ai/v1/projects/{externalProjectId}Parameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
externalProjectId | string | yes | Your reference of the project: the value of metadata.source.offererMarketingKey. A project without one has its own projectId here, and the projectId always works in the path. 1 to 128 letters, digits, dots, underscores or hyphens, not starting or ending with a dot. |
Header
| Name | Type | Required | Description |
|---|---|---|---|
Athaus-Version | string | no | Optional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported. |
If-Match | string | no | Only if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written. |
Example
curl -X DELETE "https://api.athaus.ai/v1/projects/PRJ-1-ext" \
-H "Authorization: Bearer ath_live_..."Response
On success the status is 202 with ProjectReceipt.
ProjectReceipt
| Field | Type | Description |
|---|---|---|
requestId | string | |
projectId | string | |
externalProjectId | string | |
warnings | object[] | |
warnings[].type | string | |
warnings[].message | string |
Response headers
| Header | Description |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Errors
Every error arrives as problem details. Branch on code, not on title or detail.
| Status | Codes | Meaning |
|---|---|---|
400 | api_version_unsupported, invalid_input | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
409 | project_not_empty | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. |
412 | precondition_failed | The condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Keep reading
REST API: authentication with an API key
Every call to /v1 carries an API key as a bearer token. Where to get one, which scopes it carries and what does not work.
REST API: errors as problem details
Every error from /v1 is an RFC 9457 problem with a real HTTP status, a code to branch on and a request id for support.