Atualizar os dados de uma Companhia Produtora
Descrição: Atualiza os dados de uma Companhia Produtora.
Endpoint
PUT/api/v1/integration/producers/{producer_id}
Regras
| Atributos | Descrição | Tipo | Obrigatório | Validações |
|---|---|---|---|---|
| company_name | Razão social | String | Sim | Até 255 caracteres. No caso de pessoa física, este campo não será considerado. |
| trading_name | Nome fantasia | String | Sim | Até 100 caracteres. Obs: no caso de PF informar o nome. |
| E-mail de contato | String | Não | Formatação de e-mail com @ e provedor | |
| date_of_birth | Data de nascimento | Date | Não | Este campo somente será considerado caso o campo social_identity informado seja um CPF. |
| rg | RG | String | Não | Este campo somente será considerado caso o campo social_identity informado seja um CPF. |
| marital_status | Estado Civil | Enum | Não | Este campo somente será considerado caso o campo social_identity informado seja um CPF. Enumerador(NOT_MARRIED, MARRIED, SEPARATE, DIVORCED, WIDOWER) |
| dap_code | Registro DAP | String | Não | Até 30 caracteres. |
| caf_code | Registro CAF | String | Não | Até 30 caracteres. |
| ricaf_code | Registro RICAF | String | Não | Até 30 caracteres. |
Exemplo de Requisição
- cURL
- Java
- JavaScript
- Python
curl -X PUT \
-H "Authorization: {SUA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"trading_name": "Agro Exemplo Ltda",
"company_name": "Agro Exemplo Razao Social Ltda",
"email": "contato@agroexemplo.com.br"
}' \
"https://api.merx.tech/api/v1/integration/producers/{PRODUCER_ID}"
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
String body = "{\"trading_name\": \"Agro Exemplo Ltda\", \"company_name\": \"Agro Exemplo Razao Social Ltda\", \"email\": \"contato@agroexemplo.com.br\"}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.merx.tech/api/v1/integration/producers/{PRODUCER_ID}"))
.header("Authorization", "{SUA_API_KEY}")
.header("Content-Type", "application/json")
.PUT(HttpRequest.BodyPublishers.ofString(body))
.build();
HttpClient client = HttpClient.newHttpClient();
try {
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
} catch (Exception e) {
e.printStackTrace();
}
const response = await fetch(
'https://api.merx.tech/api/v1/integration/producers/{PRODUCER_ID}',
{
method: 'PUT',
headers: {
'Authorization': '{SUA_API_KEY}',
'Content-Type': 'application/json',
},
body: JSON.stringify({
trading_name: 'Agro Exemplo Ltda',
company_name: 'Agro Exemplo Razao Social Ltda',
email: 'contato@agroexemplo.com.br',
}),
}
);
console.log(response.status);
import requests
url = "https://api.merx.tech/api/v1/integration/producers/{PRODUCER_ID}"
headers = {
"Authorization": "{SUA_API_KEY}",
"Content-Type": "application/json"
}
payload = {
"trading_name": "Agro Exemplo Ltda",
"company_name": "Agro Exemplo Razao Social Ltda",
"email": "contato@agroexemplo.com.br"
}
response = requests.put(url, json=payload, headers=headers)
print(response.status_code)
Parâmetros
Parâmetros de Caminho:
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| producer_id | Identificador da Companhia Produtora | String | Sim |
Parâmetros de Cabeçalho
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| Authorization | Chave de API obtida via support-api@merx.tech | String | Sim |
| Content-Type | application/json | String | Sim |
Parâmetros do Corpo
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| body | Sim |
Respostas
204 - No Content
400 - Bad Request
{
"messages": ["message.entidade.campo-inválido"]
}
401 - Unauthorized
404 - NotFound