Criar Oportunidade

POST /external/v1/opportunities

Cria uma nova oportunidade/lead no seu pipeline.

Autenticacao

Requer permissao opportunities:write.

Corpo da Requisicao

Campo	Tipo	Obrigatorio	Descricao
name	string	Sim	Nome completo do lead
email	string	Nao	Endereco de e-mail
phone	string	Nao	Numero de telefone com codigo do pais
company	string	Nao	Nome da empresa
position	string	Nao	Cargo/posicao
status	string	Nao	Status inicial (padrao: "new")
source	string	Nao	Origem do lead (padrao: "other")
deal_value	number	Nao	Valor estimado do negocio
deal_currency	string	Nao	Codigo da moeda (padrao: "BRL")
linkedin_url	string	Nao	URL do perfil no LinkedIn
notes	string	Nao	Observacoes adicionais
responsible_user_id	string	Nao	Atribuir a um usuario especifico

Origens Disponiveis

• linkedin - Prospeccao no LinkedIn
• google_maps - Agente Google Maps
• list - Lista importada
• paid_traffic - Publicidade paga
• other - Outras origens

Requisicao

cURL

curl --request POST \
  --url "https://app.getraze.com/external/v1/opportunities" \
  --header "Content-Type: application/json" \
  --header "X-API-Key: YOUR_API_KEY" \
  --data '{
    "name": "Jane Smith",
    "email": "jane@company.com",
    "company": "Tech Corp",
    "position": "CTO",
    "source": "paid_traffic",
    "deal_value": 75000,
    "deal_currency": "BRL",
    "notes": "Inbound from Google Ads"
  }'

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://app.getraze.com/external/v1/opportunities',
  {
    name: 'Jane Smith',
    email: 'jane@company.com',
    company: 'Tech Corp',
    position: 'CTO',
    source: 'paid_traffic',
    deal_value: 75000,
    deal_currency: 'BRL',
    notes: 'Inbound from Google Ads'
  },
  {
    headers: {
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.post(
    'https://app.getraze.com/external/v1/opportunities',
    headers={
        'X-API-Key': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'name': 'Jane Smith',
        'email': 'jane@company.com',
        'company': 'Tech Corp',
        'position': 'CTO',
        'source': 'paid_traffic',
        'deal_value': 75000,
        'deal_currency': 'BRL',
        'notes': 'Inbound from Google Ads'
    }
)

print(response.json())

Resposta

{
  "success": true,
  "data": {
    "id": "opp_xyz789abc123",
    "name": "Jane Smith",
    "email": "jane@company.com",
    "company": "Tech Corp",
    "position": "CTO",
    "status": "new",
    "source": "paid_traffic",
    "deal_value": 75000.00,
    "deal_currency": "BRL",
    "notes": "Inbound from Google Ads",
    "created_at": "2024-01-25T09:00:00Z"
  }
}

Erros

Status	Codigo	Descricao
400	VALIDATION_ERROR	Campos obrigatorios ausentes ou invalidos
400	INVALID_SOURCE	Valor de origem invalido
400	INVALID_STATUS	Valor de status invalido