Criar lead

Criar um novo lead no sistema Maya Hub

POST /user/lead

Criar lead

cURL

curl --request POST \
  --url https://app.mayahub.ai/api/user/lead \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>",
  "campaign_id": 123,
  "variables": {
    "customer_name": "<string>",
    "email": "<string>"
  },
  "allow_dupplicate": true,
  "secondary_contacts": [
    {
      "phone_number": "<string>",
      "variables": {
        "customer_name": "<string>",
        "email": "<string>"
      }
    }
  ]
}
'

import requests

url = "https://app.mayahub.ai/api/user/lead"

payload = {
    "phone_number": "<string>",
    "campaign_id": 123,
    "variables": {
        "customer_name": "<string>",
        "email": "<string>"
    },
    "allow_dupplicate": True,
    "secondary_contacts": [
        {
            "phone_number": "<string>",
            "variables": {
                "customer_name": "<string>",
                "email": "<string>"
            }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    phone_number: '<string>',
    campaign_id: 123,
    variables: {customer_name: '<string>', email: '<string>'},
    allow_dupplicate: true,
    secondary_contacts: [
      {
        phone_number: '<string>',
        variables: {customer_name: '<string>', email: '<string>'}
      }
    ]
  })
};

fetch('https://app.mayahub.ai/api/user/lead', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.mayahub.ai/api/user/lead",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone_number' => '<string>',
    'campaign_id' => 123,
    'variables' => [
        'customer_name' => '<string>',
        'email' => '<string>'
    ],
    'allow_dupplicate' => true,
    'secondary_contacts' => [
        [
                'phone_number' => '<string>',
                'variables' => [
                                'customer_name' => '<string>',
                                'email' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mayahub.ai/api/user/lead"

	payload := strings.NewReader("{\n  \"phone_number\": \"<string>\",\n  \"campaign_id\": 123,\n  \"variables\": {\n    \"customer_name\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"allow_dupplicate\": true,\n  \"secondary_contacts\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"variables\": {\n        \"customer_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.mayahub.ai/api/user/lead")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone_number\": \"<string>\",\n  \"campaign_id\": 123,\n  \"variables\": {\n    \"customer_name\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"allow_dupplicate\": true,\n  \"secondary_contacts\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"variables\": {\n        \"customer_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mayahub.ai/api/user/lead")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone_number\": \"<string>\",\n  \"campaign_id\": 123,\n  \"variables\": {\n    \"customer_name\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"allow_dupplicate\": true,\n  \"secondary_contacts\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"variables\": {\n        \"customer_name\": \"<string>\",\n        \"email\": \"<string>\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200 Response

{
  "message": "Lead created successfully",
  "data": {
    "id": 1,
    "campaign_id": 1,
    "phone_number": "[phone]",
    "variables": {
      "customer_name": "John Doe",
      "email": "[e-mail]"
    },
    "status": "created",
    "created_at": "2025-06-30 11:53:20",
    "updated_at": "2025-06-30 11:53:20",
    "campaign": {
      "id": 1,
      "name": "My new campaign"
    },
    "secondary_contacts": [
      {
        "id": 2,
        "phone_number": "[phone]",
        "variables": {
          "customer_name": "Jane Doe Secondary",
          "email": "[e-mail]"
        },
        "status": "created",
        "created_at": "2025-06-30 11:53:20",
        "updated_at": "2025-06-30 11:53:20"
      },
      {
        "id": 3,
        "phone_number": "[phone]",
        "variables": {
          "customer_name": "Bob Doe Office",
          "email": "[e-mail]"
        },
        "status": "created",
        "created_at": "2025-06-30 11:53:20",
        "updated_at": "2025-06-30 11:53:20"
      }
    ]
  }
}

Este endpoint permite criar um novo lead no sistema Maya Hub.

Corpo da solicitação

phone_number · string · required

O número de telefone do lead no formato E.164 (exemplo: [phone])

campaign_id · integer · required

O ID da campanha para a qual o lead será criado

variables · object

As variáveis a serem passadas para o lead

Show Propriedades das Variaveis

customer_name · string · default: "<string>"

O nome do cliente

email · string · default: "<string>"

O email do cliente

allow_dupplicate · boolean

Se deve permitir leads duplicados em uma campanha.

secondary_contacts · array

Array de contatos secundários a serem criados junto com o lead principal

Show Propriedades de secondary_contacts

phone_number · string · required

The phone number of the secondary contact in E.164 format

variables · object

The variables to pass to the secondary contact

Show variables properties

customer_name · string · default: "<string>"

The name of the secondary contact

email · string · default: "<string>"

The email of the secondary contact

Respostas

message · string · default: "Lead created successfully"

A mensagem da resposta

data · object

O objeto de dados do lead

Show Propriedades de data

id · integer

O ID exclusivo do lead criado

campaign_id · integer

O ID da campanha à qual este lead pertence

phone_number · string

O número de telefone do lead no formato E.164

variables · object

As variáveis associadas ao lead

Show Propriedades das Variáveis

customer_name · string · default: "<string>"

O nome do cliente

email · string · default: "<string>"

O email do cliente

status · string · default: "created"

O status do lead

created_at · string

O carimbo de data e hora em que o lead foi criado

updated_at · string

O carimbo de data e hora da última atualização do lead

campaign · object

As informações da campanha

Show Propriedades da Campanha

id · integer

O ID da campanha

name · string

O nome da campanha

secondary_contacts · array

Array de contatos secundários associados a este lead

Show Propriedades de secondary_contacts

id · integer

O ID do lead de contato secundário

phone_number · string

O número de telefone do contato secundário no formato E.164

variables · object

As variáveis associadas ao contato secundário

status · string

O status do contato secundário

created_at · string

A data de criação do contato secundário

updated_at · string

A data de atualização do contato secundário

200 Response

{
  "message": "Lead created successfully",
  "data": {
    "id": 1,
    "campaign_id": 1,
    "phone_number": "[phone]",
    "variables": {
      "customer_name": "John Doe",
      "email": "[e-mail]"
    },
    "status": "created",
    "created_at": "2025-06-30 11:53:20",
    "updated_at": "2025-06-30 11:53:20",
    "campaign": {
      "id": 1,
      "name": "My new campaign"
    },
    "secondary_contacts": [
      {
        "id": 2,
        "phone_number": "[phone]",
        "variables": {
          "customer_name": "Jane Doe Secondary",
          "email": "[e-mail]"
        },
        "status": "created",
        "created_at": "2025-06-30 11:53:20",
        "updated_at": "2025-06-30 11:53:20"
      },
      {
        "id": 3,
        "phone_number": "[phone]",
        "variables": {
          "customer_name": "Bob Doe Office",
          "email": "[e-mail]"
        },
        "status": "created",
        "created_at": "2025-06-30 11:53:20",
        "updated_at": "2025-06-30 11:53:20"
      }
    ]
  }
}