Alterar Avatar

Esta rota você pode alterar o avatar do usuário.

PUT https://api.imobiliary.com/users/avatar

Nota:

Esta rota requer autenticação. Você deve fornecer o cabeçalho Authorization com um token de autenticação válido. O token deve ser obtido através da rota de autenticação.

Requisição

Para realizar essa requisição, deve-se enviar o arquivo de imagem nos formatos permitidos: png, jpg, jpeg ou webp, com tamanho máximo de 3MB no cabeçalho da requisição, no seguinte formato:

Content-Type: multipart/form-data
Content-Disposition: form-data; name="avatar"; filename="avatar.png"

Respostas

Esses são as possíveis respostas desta requisição.

200

Receberá essa resposta caso forneça um arquivo de imagem em formato válido.

HTTP/1.1 200 OK

400

Receberá essas respostas caso não forneça um arquivo de imagem, envie um arquivo de imagem em formato inválido ou com tamanho maior que 3MB.

Exemplo de resposta por não enviar um arquivo de imagem:

{
  "status": "Bad Request",
  "code": 400,
  "result": {
    "code": 400,
    "message": "deve enviar um arquivo de avatar",
    "error": "Bad Request"
  }
}

Exemplo de resposta por enviar um arquivo em formato inválido:

{
  "status": "Bad Request",
  "code": 400,
  "result": {
    "code": 400,
    "message": "o formato do avatar deve ser .jpeg, .png, .jpg ou .webp",
    "error": "Bad Request"
  }
}

Exemplo de resposta por enviar um arquivo com tamanho maior que 3MB:

{
  "status": "Bad Request",
  "code": 400,
  "result": {
    "code": 400,
    "message": "o tamanho do arquivo de avatar deve ser menor que 3MB",
    "error": "Bad Request"
  }
}

401

Receberá essa resposta caso não envie o token de autenticação no cabecalho Authorization, caso o token enviado não seja válido ou tenha expirado.

{
  "status": "Unauthorized",
  "code": 401,
  "result": {
    "code": 401,
    "message": "token inválido ou expirado",
    "error": "Unauthorized"
  }
}

500

Receberá essa resposta caso ocorra um erro interno no servidor. Isso pode acontecer por diversos motivos, como problemas de conexão com o servidor.

Caso o problema persista Entre em contato

{
  "status": "Internal Server Error",
  "code": 500,
  "result": {
    "code": 500,
    "message": "erro interno do servidor",
    "error": "Internal Server Error"
  }
}