Gerenciar Tags

Conceituacao

As tags sao rotulos que voce pode atribuir aos contatos para categoriza-los e segmenta-los. As tags sao armazenadas como um array de strings no campo tags de cada contato.

Casos de uso

• Identificar clientes VIP ou recorrentes
• Segmentar por interesse, produto ou campanha
• Filtrar contatos para envios em massa
• Organizar atendimentos por categoria

---

Adicionar tags a um contato

Use o endpoint de atualizacao de contato para definir ou modificar tags.

Metodo

PATCH https://oapi.ogmma.com.br/v1/contacts/:contactId

cURL

curl -X PATCH "https://oapi.ogmma.com.br/v1/contacts/{contactId}" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "tags": ["vip", "cliente", "recorrente"]
  }'

Node.js

const axios = require('axios');

const response = await axios.patch(
  `https://oapi.ogmma.com.br/v1/contacts/${contactId}`,
  {
    tags: ['vip', 'cliente', 'recorrente']
  },
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.patch(
    f'https://oapi.ogmma.com.br/v1/contacts/{contact_id}',
    json={
        'tags': ['vip', 'cliente', 'recorrente']
    },
    headers={
        'Authorization': 'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
)

print(response.json())

Importante

O campo tags e substituido inteiramente pela nova lista. Para adicionar uma tag sem remover as existentes, inclua todas as tags desejadas no array.

---

Filtrar contatos por tag

Use o parametro tag no endpoint de listagem de contatos para filtrar por uma tag especifica.

Metodo

GET https://oapi.ogmma.com.br/v1/contacts?tag=vip

cURL

curl -X GET "https://oapi.ogmma.com.br/v1/contacts?tag=vip" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://oapi.ogmma.com.br/v1/contacts',
  {
    params: { tag: 'vip' },
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.get(
    'https://oapi.ogmma.com.br/v1/contacts',
    params={'tag': 'vip'},
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

---

Remover todas as tags

Para remover todas as tags de um contato, envie um array vazio.

curl -X PATCH "https://oapi.ogmma.com.br/v1/contacts/{contactId}" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"tags": []}'

---

Boas praticas

• Use tags em lowercase e sem espacos (ex: cliente-vip em vez de Cliente VIP)
• Mantenha um vocabulario consistente de tags na sua organizacao
• Evite criar tags muito especificas que serao usadas apenas uma vez
• Combine tags com envio em massa para campanhas segmentadas