DELETE
Delete a company
- Path
/companies/{companyId}- Auth
- Secret key · server only
DELETE
/companies/{companyId}
const url = 'https://releva.ai/api/v0/companies/DEMO-CO-1001';const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://releva.ai/api/v0/companies/DEMO-CO-1001 \ --header 'Authorization: Bearer <token>'Deletes the company with this companyId. Roles that link profiles to the company are not deleted;
remove them with DELETE /roles/{companyId}/{emailOrPhone}. Deleting an unknown id also returns 202.
Sending the company again with POST /companies restores it. Asynchronous.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”companyId
required
string
Your id of the company. URL-encode reserved characters.
Example
DEMO-CO-1001Responses
Section titled “Responses”Accepted for asynchronous processing.
Media typeapplication/json
object
Example
{}Authorization header missing, malformed, not a UUID, or unknown.
Media typeapplication/json
object
message
required
Human-readable error. Several validation errors are joined with a space.
string
Examples
{ "message": "Authorization header is missing."}{ "message": "Authorization header is malformed. It should look like `Bearer <string>`."}{ "message": "Authorization header contains an invalid Bearer token."}{ "message": "Domain with the provided secret key cannot be found."}The domain is disabled.
Media typeapplication/json
object
message
required
Human-readable error. Several validation errors are joined with a space.
string
Example
{ "message": "Domain is disabled. Please reach out to support@releva.ai to enable it."}Unexpected server error.
Media typeapplication/json
object
message
required
Human-readable error. Several validation errors are joined with a space.
string
Example
{ "message": "An internal error occurred."}