Atualizar um usuário interno de uma Companhia Produtora

Descrição: Atualiza um usuário interno.

Endpoint

PUT/api/v1/integration/producer-users/{producer_user_id}/producers/{producer_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
auth	Tipo de autenticação exigida para confirmação de autenticidade do usuário	Enum	Sim	Enumerador (EMAIL, SMS, WHATSAPP, API)
default_signer	Usuário é o signatário padrão da Companhia Produtora?	Boolean	Sim	Apenas valores booleanos
delivery	Informa como o signatário receberá as notificações	Enum	Sim	Enumerador (EMAIL, NONE)
phone_number	Telefone celular de contato	String	Sim	Formato +5511999999999
email	Email de contato	String	Não	Formatação de e-mail com @ e provedor
sign_as	O usuário irá assinar como testemunha ou representante legal	Enum	Sim	Enumerador (WITNESS, LEGAL_REPRESENTATIVE)
full_name	Nome completo	String	Sim	Até 255 caracteres
given_name	Primeiro nome	String	Não	-
family_name	Sobrenome	String	Não	-
locale	Localidade do usuário	String	Não	-
zoneinfo	Fuso horário do usuário	String	Não	-
social_id	CPF do usuário	String	Não	-
preferred_username	Nome de usuário preferido	String	Não	-
preferred_username_type	Tipo de nome de usuário preferido	Enum	Não	-
rne	RNE (Registro Nacional de Estrangeiro)	String	Não	-
passport_number	Número do passaporte	String	Não	-
company_id	Identificador da empresa	UUID	Não	-
type	Tipo de assinante	Enum	Não	-

Exemplo de Requisição

cURL

curl -X PUT \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Carlos Eduardo Ferreira",
    "phone_number": "+5511999999999",
    "email": "carlos.ferreira@cooperativa.com.br",
    "auth": "EMAIL",
    "delivery": "EMAIL",
    "sign_as": "LEGAL_REPRESENTATIVE",
    "default_signer": true
  }' \
  "https://api.merx.tech/api/v1/integration/producer-users/{producer_user_id}/producers/{producer_id}"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String body = "{\"full_name\": \"Carlos Eduardo Ferreira\", \"phone_number\": \"+5511999999999\", \"auth\": \"EMAIL\", \"delivery\": \"EMAIL\", \"sign_as\": \"LEGAL_REPRESENTATIVE\", \"default_signer\": true}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/producer-users/{producer_user_id}/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();
}

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/producer-users/{producer_user_id}/producers/{producer_id}',
  {
    method: 'PUT',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      full_name: 'Carlos Eduardo Ferreira',
      phone_number: '+5511999999999',
      email: 'carlos.ferreira@cooperativa.com.br',
      auth: 'EMAIL',
      delivery: 'EMAIL',
      sign_as: 'LEGAL_REPRESENTATIVE',
      default_signer: true,
    }),
  }
);
console.log(response.status);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/producer-users/{producer_user_id}/producers/{producer_id}"

headers = {
    "Authorization": "{SUA_API_KEY}",
    "Content-Type": "application/json"
}

payload = {
    "full_name": "Carlos Eduardo Ferreira",
    "phone_number": "+5511999999999",
    "email": "carlos.ferreira@cooperativa.com.br",
    "auth": "EMAIL",
    "delivery": "EMAIL",
    "sign_as": "LEGAL_REPRESENTATIVE",
    "default_signer": True
}

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_user_id	Identificador do usuário interno	String	Sim
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
auth	Tipo de autenticação exigida	String	Sim
default_signer	Usuário é o signatário padrão da Companhia Produtora?	Boolean	Sim
delivery	Informa como o signatário receberá as notificações	String	Sim
phone_number	Telefone celular de contato	String	Sim
email	Email de contato	String	Não
sign_as	O usuário irá assinar como testemunha ou representante legal	String	Sim
full_name	Nome completo	String	Sim
given_name	Primeiro nome	String	Não
family_name	Sobrenome	String	Não
locale	Localidade do usuário	String	Não
zoneinfo	Fuso horário do usuário	String	Não
social_id	CPF do usuário	String	Não
preferred_username	Nome de usuário preferido	String	Não
preferred_username_type	Tipo de nome de usuário preferido	Enum	Não
rne	RNE (Registro Nacional de Estrangeiro)	String	Não
passport_number	Número do passaporte	String	Não
company_id	Identificador da empresa	UUID	Não
type	Tipo de assinante	Enum	Não

Respostas

• 204 - No content

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 401 - Unauthorized

• 404 - NotFound