Atualizar contato

Método

PUT https://oapi.ogmma.com.br/v1/contacts/:id

Conceituação

Este endpoint permite atualizar os dados de um contato existente. A atualização parcial é suportada -- você pode enviar apenas os campos que deseja alterar.

Ao atualizar tags, o array informado substituirá completamente as tags existentes. Para adicionar uma tag sem remover as demais, inclua todas as tags desejadas no array.

Ao atualizar metadata, o objeto informado será mesclado com os metadados existentes. Para remover um campo de metadata, envie-o com valor null.

---

Atributos

Header

Atributo	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticação
Content-Type	string	Sim	application/json

Parâmetros de URL

Atributo	Tipo	Obrigatório	Descrição
id	string	Sim	ID do contato a ser atualizado

Body

Atributo	Tipo	Obrigatório	Descrição
name	string	Não	Nome do contato. Mínimo: 1 caractere. Máximo: 200 caracteres
phone	string	Não	Número de telefone no formato internacional (ex: 5511999999999)
email	string	Não	Endereço de e-mail do contato
tags	string[]	Não	Array de tags (substitui as tags existentes)
metadata	object	Não	Objeto com campos personalizados (mesclado com existentes)

---

Request

cURL

curl -X PUT "https://oapi.ogmma.com.br/v1/contacts/{id}" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria Silva Santos",
    "tags": ["vip", "recorrente", "premium"],
    "metadata": {
      "plano": "enterprise",
      "cpf": null
    }
  }'

Node.js

const axios = require('axios');

const response = await axios.put(
  'https://oapi.ogmma.com.br/v1/contacts/{id}',
  {
    name: 'Maria Silva Santos',
    tags: ['vip', 'recorrente', 'premium'],
    metadata: {
      plano: 'enterprise',
      cpf: null
    }
  },
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.put(
    'https://oapi.ogmma.com.br/v1/contacts/{id}',
    json={
        'name': 'Maria Silva Santos',
        'tags': ['vip', 'recorrente', 'premium'],
        'metadata': {
            'plano': 'enterprise',
            'cpf': None
        }
    },
    headers={
        'Authorization': 'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
)

print(response.json())

Ao atualizar metadata, o objeto informado sera mesclado com os metadados existentes. Para remover um campo de metadata, envie-o com valor null (como o campo cpf no exemplo acima).

---

Response

200 - Success

O contato foi atualizado com sucesso.

{
  "data": {
    "id": "6650b2c3d4e5f6a7890124",
    "name": "Maria Silva Santos",
    "phone": "5511999990001",
    "email": "maria@email.com",
    "tags": ["vip", "recorrente", "premium"],
    "metadata": {
      "empresa": "Acme Ltda",
      "plano": "enterprise",
      "dataAniversario": "1990-05-15"
    },
    "createdAt": "2025-05-01T10:00:00Z",
    "updatedAt": "2025-06-10T15:10:00Z"
  }
}

400 - Bad Request

Parâmetros inválidos ou número de telefone duplicado.

{
  "message": "O campo 'name' deve ter no mínimo 1 caractere.",
  "code": "VALIDATION_ERROR"
}

401 - Unauthorized

Chave de API inválida ou ausente.

{
  "message": "Chave de API inválida ou expirada.",
  "code": "UNAUTHORIZED"
}

429 - Too Many Requests

Limite de requisições excedido.

{
  "message": "Limite de requisições excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}