Foccuz Integration API
  1. API externa
Foccuz Integration API
  • API externa
    • Comenzando con Foccuz Integration API
    • Autenticación vía API Key
    • Límite de uso (Rate Limiting) y Restricciones de tamaño (Body Size Limiting)
    • Colaboradores con Compensaciones Variables (Usuario/Colaborador)
    • Empresas (Clientes/Cuentas/Compañías)
    • Negocio (Operación, Venta, Cobranza, Acción clave)
    • Actividad (Acción, Productividad, Indicador)
    • Campos personalizados
    • Orden de ejecucción
    • Consideraciones
    • Flujos de ejemplo
    • Manejo de errores
    • v2
      • integration
        • deals
          • /v2/integration/deals
          • /v2/integration/deals
        • activities
          • /v2/integration/activities
          • /v2/integration/activities
        • account
          • /v2/integration/account
          • /v2/integration/account
        • sales-profile
          • /v2/integration/sales-profile
          • /v2/integration/sales-profile
  • Integraciones
    • Buk
      • Conectarse con Buk
  1. API externa

Colaboradores con Compensaciones Variables (Usuario/Colaborador)

Nombre de la entidad: SalesProfile
Descripción: Representa a un usuario/colaborador al cual se evaluará para calcular sus comisiones e incentivos variables.
Endpoint: POST /v2/integration/sales-profile

Propiedades Requeridas:#

externalId (string): Identificador único en el sistema externo
email (string): Email del usuario (debe ser válido)

Propiedades Opcionales:#

customFields (array): Campos personalizados
profile (object): Información adicional del perfil
firstName (string): Nombre
lastName (string): Apellido

Ejemplo de Request:#

{
  "batchId": "batch-001",
  "source": "external-crm",
  "items": [
    {
      "externalId": "USER-001",
      "email": "john.doe@company.com",
      "profile": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "customFields": [
        {
          "key": "department",
          "type": string,
          "value": "Sales",
          "name": "custom_field_1"
        }
      ]
    }
  ]
}
Modificado en 2025-10-10 13:43:57
Anterior
Límite de uso (Rate Limiting) y Restricciones de tamaño (Body Size Limiting)
Siguiente
Empresas (Clientes/Cuentas/Compañías)
Built with