Integraciones

Recibir un contacto desde una integración

POST/integraciones/:token

Recibe un contacto y aplica la configuración de la integración. Debes enviar al menos correo o movil. Si el contacto ya existe, puede registrar una nueva solicitud y ejecutar las acciones de recurrencia; no equivale a reemplazar todos sus datos. Si hay un mapeo configurado se aplica antes de procesar el cuerpo. La operación puede asignar etiquetas, distribuir el contacto y activar notificaciones o automatizaciones. Usa trid para reconocer reintentos ya registrados. Si faltan correo y movil puede devolver HTTP 200 y code: 0, pero el contacto no se inserta: verifica que la respuesta incluya details y tkContacto. El alias POST /integracion recibe el token de integración en el cuerpo o la consulta.

Rutas alternativas

/integracion

Parámetros

Nombre	Tipo	Validación	Descripción
`trid`	uniqueidentifier		Cuerpo: UUID de la solicitud. Reutiliza el mismo valor al reintentar una solicitud: si ya existe en el historial de la cuenta, devuelve action: duplicated sin volver a procesarla. No lo reutilices para solicitudes distintas.
`gbraid`	varchar		Cuerpo: Identificador de clic publicitario. Hasta 512 caracteres.
`wbraid`	varchar		Cuerpo: Identificador de clic publicitario. Hasta 512 caracteres.
`token`	String	Requerido	URL (obligatorio): Token completo de la integración, incluido su prefijo si lo tiene. Conserva el valor proporcionado por Upnify.
`nombre`	String		Cuerpo: Nombre del contacto. Se conservan hasta 128 caracteres.
`apellidos`	String		Cuerpo: Apellidos del contacto. Se conservan hasta 128 caracteres.
`correo`	String		Cuerpo: Correo del contacto. Debes enviar correo o movil para que se procese el contacto.
`movil`	String		Cuerpo: Móvil del contacto. Debes enviar movil o correo; incluye el prefijo internacional cuando lo conozcas.
`telefono`	String		Cuerpo: Teléfono del contacto.
`telefono2`	String		Cuerpo: Teléfono adicional.
`empresa`	String		Cuerpo: Nombre de la compañía del contacto.
`puesto`	String		Cuerpo: Puesto del contacto.
`comentarios`	String		Cuerpo: Comentario de la solicitud. Hasta 8000 caracteres.
`tkUsuario`	String		Cuerpo: Identificador del ejecutivo que recibirá el contacto. Si se omite se aplica la configuración y distribución de la integración.
`tkFase`	String		Cuerpo: Identificador de la fase inicial.
`fase`	String		Cuerpo: Nombre o identificador de una fase. tkFase tiene prioridad para un contacto nuevo.
`tkOrigen`	String		Cuerpo: Identificador del origen del contacto; tiene prioridad sobre origen.
`origen`	String		Cuerpo: Nombre o identificador del origen.
`tkEtiqueta`	String		Cuerpo: Identificadores de etiquetas separados por comas.
`etiqueta`	String		Cuerpo: Nombre o identificador de la primera etiqueta.
`etiqueta2`	String		Cuerpo: Nombre o identificador de una segunda etiqueta.
`etiqueta3`	String		Cuerpo: Nombre o identificador de una tercera etiqueta.
`idPais`	String		Cuerpo: Código del país. Si se omite o no es válido se aplica el país de la cuenta o del ejecutivo.
`pais`	String		Cuerpo: Nombre del país para resolver su código.
`idEstado`	String		Cuerpo: Código del estado.
`pestado`	String		Cuerpo: Nombre del estado para resolver su código.
`ciudad`	String		Cuerpo: Ciudad del contacto.
`pciudad`	String		Cuerpo: Texto complementario de ciudad.
`idMunicipio`	String		Cuerpo: Identificador del municipio.
`direccion1`	String		Cuerpo: Dirección principal.
`calle`	String		Cuerpo: Calle que se agrega a la dirección principal.
`direccion2`	String		Cuerpo: Dirección complementaria.
`codigoPostal`	String		Cuerpo: Código postal.
`refiere`	String		Cuerpo: Persona o referencia de origen del contacto.
`sexo`	String		Cuerpo: Valor de sexo del contacto.
`esCliente`	Integer		Cuerpo: 1 para crear como cliente; 0 para crear como prospecto.
`web`	String		Cuerpo: Sitio web del contacto.
`paginaWeb`	String		Cuerpo: Texto de sitio web adicional.
`url`	String		Cuerpo: URL de origen de la solicitud. Hasta 512 caracteres.
`referrer`	String		Cuerpo: Página de referencia. Hasta 512 caracteres.
`cp`	String		Cuerpo: Objeto JSON serializado con los campos personalizados. Sus claves dependen de los campos configurados en la cuenta.
`datosAdicionales`	String		Cuerpo: Objeto JSON serializado con datos adicionales del contacto.
`firma`	String		Cuerpo: Firma asociada al contacto.
`tkEvento`	String		Cuerpo: Identificador de un evento para registrar el contacto.
`tkWidget`	String		Cuerpo: Identificador del widget desde el que se registra.
`tkWidgetActivacion`	String		Cuerpo: Identificador de la activación del widget.
`tkPlantillaCorreo`	String		Cuerpo: Identificador de una plantilla que se enviará al contacto cuando corresponda.
`gclid`	String		Cuerpo: Identificador de clic publicitario. Hasta 512 caracteres.
`fbclid`	String		Cuerpo: Identificador de clic publicitario. Hasta 512 caracteres.
`utm_source`	String		Cuerpo: Fuente de campaña. Hasta 512 caracteres.
`utm_medium`	String		Cuerpo: Medio de campaña. Hasta 512 caracteres.
`utm_campaign`	String		Cuerpo: Campaña. Hasta 512 caracteres.
`utm_term`	String		Cuerpo: Término de búsqueda. Hasta 512 caracteres.
`utm_content`	String		Cuerpo: Contenido de campaña. Hasta 512 caracteres.
`utm_date`	String		Cuerpo: Fecha de atribución. Hasta 512 caracteres.
`customfield1`	String		Cuerpo: Valor adicional de atribución 1. Hasta 512 caracteres.
`customfield2`	String		Cuerpo: Valor adicional de atribución 2. Hasta 512 caracteres.
`customfield3`	String		Cuerpo: Valor adicional de atribución 3. Hasta 512 caracteres.
`customfield4`	String		Cuerpo: Valor adicional de atribución 4. Hasta 512 caracteres.
`customfield5`	String		Cuerpo: Valor adicional de atribución 5. Hasta 512 caracteres.

Respuesta

Nombre	Tipo	Descripción
`code`	Integer	0 en las respuestas ordinarias. La respuesta de una solicitud duplicada puede omitirlo.
`msg`	String	Mensaje de resultado; revísalo junto con details.
`details`	Array<Object>	Resultado del contacto. No aparece cuando falta correo y movil.
`details[].tkContacto`	String	Identificador del contacto creado, localizado o actualizado.
`details[].action`	String	Acción realizada: created, updated o duplicated.

Solicitud

curl --request POST \
  --url https://api.upnify.com/integraciones/P01AP00000000-0000-4000-8000-000000000001 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "nombre": "Persona de ejemplo",
  "correo": "persona@example.com",
  "comentarios": "Solicitud desde el formulario",
  "trid": "00000000-0000-4000-8000-000000000001"
}'async function ejecutar() {
  const response = await fetch("https://api.upnify.com/integraciones/P01AP00000000-0000-4000-8000-000000000001", {
    method: "POST",
    headers: {"Accept": "application/json", "Content-Type": "application/json"},
    body: JSON.stringify({"nombre":"Persona de ejemplo","correo":"persona@example.com","comentarios":"Solicitud desde el formulario","trid":"00000000-0000-4000-8000-000000000001"})
  });
  const text = await response.text();
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
  const data = text ? JSON.parse(text) : null;
  // Usa data en tu aplicación sin exponer tokens o datos personales.
  console.log("Estado HTTP:", response.status);
}

ejecutar().catch(console.error);// Node.js 18 o posterior.
async function ejecutar() {
  const response = await fetch("https://api.upnify.com/integraciones/P01AP00000000-0000-4000-8000-000000000001", {
    method: "POST",
    headers: {"Accept": "application/json", "Content-Type": "application/json"},
    body: JSON.stringify({"nombre":"Persona de ejemplo","correo":"persona@example.com","comentarios":"Solicitud desde el formulario","trid":"00000000-0000-4000-8000-000000000001"})
  });
  const text = await response.text();
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
  const data = text ? JSON.parse(text) : null;
  // Usa data en tu aplicación sin exponer tokens o datos personales.
  console.log("Estado HTTP:", response.status);
}

ejecutar().catch(console.error);import json
import requests

response = requests.request(
    "POST",
    "https://api.upnify.com/integraciones/P01AP00000000-0000-4000-8000-000000000001",
    headers={'Accept': 'application/json', 'Content-Type': 'application/json'},
    json=json.loads('{"nombre":"Persona de ejemplo","correo":"persona@example.com","comentarios":"Solicitud desde el formulario","trid":"00000000-0000-4000-8000-000000000001"}'),
    timeout=30,
)
response.raise_for_status()
data = response.json() if response.text else None
# Usa data en tu aplicación sin exponer tokens o datos personales.
print("Estado HTTP:", response.status_code)package main

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

func main() {
  body := strings.NewReader(`{"nombre":"Persona de ejemplo","correo":"persona@example.com","comentarios":"Solicitud desde el formulario","trid":"00000000-0000-4000-8000-000000000001"}`)
  request, err := http.NewRequest("POST", "https://api.upnify.com/integraciones/P01AP00000000-0000-4000-8000-000000000001", body)
  if err != nil { panic(err) }
  request.Header.Set("Accept", "application/json")
  request.Header.Set("Content-Type", "application/json")
  client := &http.Client{Timeout: 30 * time.Second}
  response, err := client.Do(request)
  if err != nil { panic(err) }
  defer response.Body.Close()
  data, err := io.ReadAll(response.Body)
  if err != nil { panic(err) }
  if response.StatusCode < 200 || response.StatusCode >= 300 {
    panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data))
  }
  fmt.Println("Estado HTTP:", response.StatusCode)
}using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.upnify.com/integraciones/P01AP00000000-0000-4000-8000-000000000001");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent("{\"nombre\":\"Persona de ejemplo\",\"correo\":\"persona@example.com\",\"comentarios\":\"Solicitud desde el formulario\",\"trid\":\"00000000-0000-4000-8000-000000000001\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
var data = await response.Content.ReadAsStringAsync();
response.EnsureSuccessStatusCode();
Console.WriteLine($"Estado HTTP: {(int)response.StatusCode}");

Respuesta

[
  {
    "code": 0,
    "msg": "Ok",
    "details": [
      {
        "tkContacto": "P-00000000-0000-4000-8000-000000000001",
        "action": "created"
      }
    ]
  }
]

[
  {
    "msg": "Ok",
    "details": [
      {
        "tkContacto": "P-00000000-0000-4000-8000-000000000001",
        "action": "duplicated"
      }
    ]
  }
]

[
  {
    "code": 0,
    "msg": "El contacto no se insertó, el correo o móvil es requerido por favor vuelva a intentarlo"
  }
]

Recibir un contacto desde una integración

Rutas alternativas

Parámetros

Respuesta

Solicitud

Enviar un contacto con un identificador de solicitud

Respuesta

Contacto procesado (HTTP 200)

Reintento ya registrado (HTTP 200)

Solicitud sin correo ni móvil (HTTP 200)