Empregadores · Excluir

Excluir um empregador

Sem envios, apaga o cadastro. Com envios, o empregador sai da lista e para de receber eventos; o histórico e os comprovantes ficam, e dá para restaurar.

DELETE https://integration.enviaesocial.com.br/v1/employers/{uuid}

Autenticação Bearer es_…

Corpo Sem corpo

Sucesso 200 employer_removed

Evento novo de empregador excluído responde 422 employer_not_found. Com envio em andamento, a exclusão espera: 409 employer_has_pending_events.

Caminho

uuid uuid

obrigatório

O uuid do empregador.

Respostas

200 employer_removed

Excluído. Em data.deleted, HARD apagou o cadastro (não tinha envios) e SOFT guardou com o histórico.

404 not_found

Não existe nesta empresa.

409 employer_deleted

Já está excluído.

409 employer_has_pending_events

Tem envio em andamento.

401 invalid_api_key

Chave ausente, inválida ou revogada.

$http = new GuzzleHttp\Client([ 'base_uri' => 'https://integration.enviaesocial.com.br/v1/', 'headers' => ['Authorization' => 'Bearer ' . getenv('ENVIAESOCIAL_KEY')],]); $response = $http->delete('employers/{uuid}');$result = json_decode($response->getBody(), true);

const res = await fetch('https://integration.enviaesocial.com.br/v1/employers/{uuid}', { method: 'DELETE', headers: { Authorization: `Bearer ${process.env.ENVIAESOCIAL_KEY}` },});const { data } = await res.json();

import osimport requests auth = {"Authorization": f"Bearer {os.environ['ENVIAESOCIAL_KEY']}"} res = requests.delete("https://integration.enviaesocial.com.br/v1/employers/{uuid}", headers=auth)data = res.json()["data"]

using var http = new HttpClient { BaseAddress = new Uri("https://integration.enviaesocial.com.br/v1/") };http.DefaultRequestHeaders.Authorization = new("Bearer", Environment.GetEnvironmentVariable("ENVIAESOCIAL_KEY")); var res = await http.DeleteAsync("employers/{uuid}");var json = await res.Content.ReadAsStringAsync();

{ "status": "error", "message": "employer_deleted", "data": { "errors": [ { "field": null, "code": "employer_deleted", "detail": "Este empregador foi excluído. Restaure em Empregadores." } ] }}

{ "status": "error", "message": "employer_has_pending_events", "data": { "errors": [ { "field": null, "code": "employer_has_pending_events", "detail": "Este empregador tem envios em andamento. Espere terminarem para excluir." } ] }}

{ "status": "error", "message": "invalid_api_key", "data": { "errors": [ { "field": null, "code": "invalid_api_key", "detail": "Chave de API ausente, inválida ou revogada." } ] }}