Atualizar um Usuário Participante

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

Endpoint

PUT/api/v1/integration/guest-users/{guest_user_id}/producers/{producer_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
guest_user_id	Identificador do Guest User	UUID	Sim	-
producer_id	Identificador da Companhia Produtora	UUID	Sim	-
email	E-mail de contato	String	Sim	Formatação de e-mail com @ e provedor e deve ser único
marital_status	Estado civil	Enum	Não	NOT_MARRIED, MARRIED, SEPARATE, DIVORCED, WIDOWER
name	Nome Completo	String	Sim	Até 50 caracteres
phone	Número de celular para contato	String	Não	Atender ao formato +5511999999999
address.city	Cidade	String	Não	Até 250 caracteres
address.country	País	String	Não	Até 50 caracteres
address.neighborhood	Bairro	String	Não	Até 250 caracteres
address.number	Número	String	Não	Apenas números
address.state	Estado	String	Não	Até 2 caracteres (Sigla)
address.street	Rua	String	Não	Até 250 caracteres
address.complement	Complemento	String	Não	Até 250 caracteres
address.zip_code	CEP	String	Não	CEP com "-"
signer.default_signer	Usuário é o signatário padrão	Bool	Sim	Apenas valores booleanos
signer.sign_as	O usuário irá assinar como testemunha ou representante legal	Enum	Sim	WITNESS, LEGAL_REPRESENTATIVE
signer.auth	Tipo de autenticação exigida para confirmação do usuário no momento da assinatura do contrato	Enum	Sim	EMAIL, SMS, WHATSAPP
signer.delivery	Informa como o signatário receberá as notificações de confirmação de assinatura e de documento finalizado	Enum	Sim	EMAIL, NONE

Exemplo de Requisição

cURL

curl -X PUT \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria Oliveira",
    "email": "maria.oliveira@parceiro.com.br",
    "phone": "+5511999999999",
    "signer": {
      "auth": "EMAIL",
      "delivery": "EMAIL",
      "default_signer": true,
      "sign_as": "LEGAL_REPRESENTATIVE"
    }
  }' \
  "https://api.merx.tech/api/v1/integration/guest-users/{guest_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 = "{\"name\": \"Maria Oliveira\", \"email\": \"maria.oliveira@parceiro.com.br\", \"phone\": \"+5511999999999\", \"signer\": {\"auth\": \"EMAIL\", \"delivery\": \"EMAIL\", \"default_signer\": true, \"sign_as\": \"LEGAL_REPRESENTATIVE\"}}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/guest-users/{guest_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/guest-users/{guest_user_id}/producers/{producer_id}',
  {
    method: 'PUT',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Maria Oliveira',
      email: 'maria.oliveira@parceiro.com.br',
      phone: '+5511999999999',
      signer: {
        auth: 'EMAIL',
        delivery: 'EMAIL',
        default_signer: true,
        sign_as: 'LEGAL_REPRESENTATIVE',
      },
    }),
  }
);
console.log(response.status);

Python

import requests

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

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

payload = {
    "name": "Maria Oliveira",
    "email": "maria.oliveira@parceiro.com.br",
    "phone": "+5511999999999",
    "signer": {
        "auth": "EMAIL",
        "delivery": "EMAIL",
        "default_signer": True,
        "sign_as": "LEGAL_REPRESENTATIVE"
    }
}

response = requests.put(url, json=payload, headers=headers)
print(response.status_code)

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
guest_user_id	Identificador do Guest User	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 de Corpo

Nome	Descrição	Tipo	Obrigatório	Validações / Enumeradores
name	Nome Completo	String	Sim	Até 50 caracteres
email	E-mail de contato	String	Sim	Formatação de e-mail com @ e provedor
signer	Dados do signatário	Object	Sim	-
signer.default_signer	Usuário é o signatário padrão	Boolean	Sim	Apenas valores booleanos
signer.sign_as	O usuário irá assinar como testemunha ou representante legal	Enum	Sim	WITNESS, LEGAL_REPRESENTATIVE
signer.auth	Tipo de autenticação exigida para confirmação do usuário no momento da assinatura do contrato	Enum	Sim	EMAIL, SMS, WHATSAPP, API
signer.delivery	Informa como o signatário receberá as notificações de confirmação de assinatura e de documento finalizado	Enum	Sim	EMAIL, NONE
social_security	Documento de identidade (RG/matrícula)	String	Não	Até 12 caracteres, padrão [a-zA-Z0-9]*
phone	Número de celular para contato	String	Não	Formato +5511999999999
identity_card	Cartão de identidade	String	Não	Até 30 caracteres, padrão [a-zA-Z0-9]*
marital_status	Estado civil	Enum	Não	NOT_MARRIED, MARRIED, SEPARATE, DIVORCED, WIDOWER
address	Endereço	Object	Não	-
address.street	Rua	String	Não	Até 250 caracteres
address.number	Número	String	Não	-
address.complement	Complemento	String	Não	Até 250 caracteres
address.neighborhood	Bairro	String	Não	Até 250 caracteres
address.zip_code	CEP	String	Não	Formato com "-"
address.city	Cidade	String	Não	Até 250 caracteres
address.state	Estado	String	Não	Até 2 caracteres (sigla)
address.country	País	String	Não	Até 50 caracteres

Respostas

• 204 - No content

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound