AthausDocs

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

NameTypeRequiredDescription
externalProjectIdstringyesYour 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

NameTypeRequiredDescription
Athaus-VersionstringnoOptional 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-MatchstringnoOnly 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

FieldTypeDescription
requestIdstring
projectIdstring
externalProjectIdstring
warningsobject[]
warnings[].typestring
warnings[].messagestring

Response headers

HeaderDescription
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Errors

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400api_version_unsupported, invalid_inputInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
409project_not_emptyThe request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
412precondition_failedThe condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page