Atualizar as informações de um contacto existente
PUT
https://api.lws.net/v1/
operationIdputContact
Atualiza as informações de um contacto existente. Apenas os campos fornecidos serão atualizados.
Parâmetros do caminho
-
contactinteger obrigatório -
ID do contacto a atualizar
Corpo do pedido
application/json
-
addressanyopcionalMorada
-
postalstringopcionalCódigo postal
-
cityanyopcionalCidade
-
countryanyopcionalPaís
-
phoneanyopcionalNúmero de telefone do contacto no formato internacional 00{código do país}{número}
-
passwordanyopcionalPalavra-passe
Exemplo de pedido
{
"address": "1 rue de la Paix",
"postal": "75000",
"city": "Paris",
"country": "FR",
"phone": "0033612345678",
"password": "password"
}
Respostas
200
Contacto atualizado com sucesso
{
"code": 200,
"info": "Updated contact information",
"data": {
"address": "1 rue de la Paix",
"postal": "75000",
"city": "Paris",
"country": "FR",
"phone": "0033612345678",
"password": "password"
}
}
Campos da resposta 9
-
codeinteger -
infostring -
dataobject -
addressanyMorada
-
postalstringCódigo postal
-
cityanyCidade
-
countryanyPaís
-
phoneanyNúmero de telefone do contacto no formato internacional 00{código do país}{número}
-
passwordanyPalavra-passe
201
Nada a atualizar, pois não foi fornecido nenhum campo
{
"code": 201,
"info": "Nothing to update"
}
Campos da resposta 2
-
codeinteger -
infostring
400
Foram fornecidos parâmetros inválidos
{
"code": 400,
"info": "Invalid input",
"data": {
"city": "Invalid field, refer to the associated regex for more details"
}
}
Campos da resposta 3
-
codeinteger -
infostring -
dataobject
401
Não autorizado - Faltam os cabeçalhos de autenticação
{
"code": 401,
"info": "Unauthorized access to the API. Please specify X-Auth-Pass and X-Auth-Login to proceed."
}
Campos da resposta 2
-
codeinteger -
infostring
429
Limite de pedidos excedido
{
"code": 429,
"info": "Rate limit exceeded. Please try again later."
}
Campos da resposta 2
-
codeinteger -
infostring
500
Erro interno do servidor
{
"code": 500,
"info": "Internal Server Error",
"data": "Details on the error"
}
Campos da resposta 3
-
codeinteger -
infostring -
datastring
502
Foi devolvida uma resposta inválida. Significa geralmente que os dados devolvidos não eram os esperados.
{
"code": 502,
"info": "Invalid response from upstream server",
"data": {
"status": 500,
"error": "Internal Server Error"
}
}
Campos da resposta 3
-
codeinteger -
infostring -
dataany[]