SOAR API Documentation

Editar Organização

Descrição

Atualiza os dados de uma organização existente com base no ID fornecido.

Verbo

PUT

URL Base

https://api.soargi.com

Endpoint

/organizations/{id}

Cabeçalhos

Parâmetro	Valor
Content-Type	application/json
Authorization	Bearer Token

Campos Permitidos

Campo	Tipo	Obrigatório	Descrição
org_name	string	Não	Nome da organização.
email	string	Não	E-mail da organização. Deve ser único.
description	string	Não	Descrição da organização.
phone	string	Não	Telefone de contato.
country	string	Não	País.
state	string	Não	Estado.
city	string	Não	Cidade.
address	string	Não	Endereço completo.
postal_code	string	Não	CEP ou código postal.
avatarUrl	string\|null	Não	URL da imagem de capa/avatar da organização. Se enviado como `null` ou string vazia, a imagem atual é removida do Azure Blob Storage.
remove_image	boolean	Não	Flag opcional para remoção explícita da imagem atual. Quando `true`, remove o blob atual e define `avatarUrl` como `null`, mesmo que o campo `avatarUrl` não seja enviado.

Exemplo de Requisição

{
  "org_name": "Nova Organização",
  "email": "nova@org.com.br",
  "description": "Atualizando dados da organização.",
  "country": "Brasil",
  "state": "SP",
  "city": "Campinas",
  "remove_image": true
}

Dica: se preferir, você também pode remover a imagem enviando "avatarUrl": null (sem o campo remove_image). Em ambos os casos o blob antigo será removido do Azure Blob Storage.

Respostas

Sucesso - 200

{
  "status": "success",
  "message": "Organization updated successfully"
}

Erro - 400 (Dados inválidos)

{
  "status": 400,
  "error": 400,
  "messages": {
    "email": "The email must be unique."
  }
}

Erro - 404 (Organização não encontrada)

{
  "status": 404,
  "message": "Organization not found"
}

Códigos de Resposta

200 - Organização atualizada com sucesso
400 - Dados inválidos ou e-mail já utilizado
404 - Organização não encontrada