LeadAPIValidationUtilOOB - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 3 min. de leitura
  • . LeadAPIValidationUtilOOB a inclusão de script fornece métodos que são chamados pelo lead REST API para validar registros de lead e registros de item de linha de lead associados quando eles são criados (POST) ou atualizados (PATCH).

    Se você quiser personalizar como os registros de lead são validados quando API do Lead os métodos são chamados, substitua os métodos nesta inclusão de script no LeadAPIValidationUtil inclusão de script. Os nomes dos métodos que você está substituindo no LeadAPIValidationUtil a inclusão de script deve ser igual às do LeadAPIValidationUtilOOB arquivo de inclusão de script.

    Esta API é fornecida no sn_lead_mgmt_core namespace. Para acessar a API, o plug-in Modelo de dados de gestão de leads (sn_lead_mgmt_core) deve ser ativado na instância e o usuário chamador deve ter a função sn_lead_mgmt_core.lead_integrator.

    Para obter informações adicionais sobre Gestão de leads, consulte Using Lead Management.

    LeadAPIValidationUtilOOB - validateLeadObjectForPatchCall (objeto leadObject)

    Valida os campos aprovados para um lead especificado e seus itens de linha associados ao atualizar um registro de lead usando PATCH endpoint do lead API.

    Este método é acionado pelo ProcessUpdateLead() método no LeadAPIValidationUtilOOB inclusão de script. Este método executa várias validações, como:
    • Verifica se há campos obrigatórios
    • Verifica se o número de telefone e o endereço de e-mail têm o formato adequado.
    • Verifica os campos de escolha e referência, ignorando todos os valores inválidos.
    • Valida a fase e gera um erro se o usuário tentar qualificar um lead.
    Tabela 1. Parâmetros
    Nome Tipo Descrição
    LeadObject Objeto Campos a serem atualizados no registro de lead especificado e nos registros de item de linha de lead associados. Para obter uma lista dos campos que podem ser aprovados e seus requisitos associados, consulte Lead - PATCH /sn_lead_mgmt_core/lead/.
    Tabela 2. Retornos
    Tipo Descrição
    <JSON object> Resultados da validação.
    {
      "errors": [Array],
      "indexesOfleadLineItemsForInsertion": [Array] 
    } 
    Erros.<JSON object> Detalhes dos erros detectados ao validar o lead aprovado e o objeto de item de linha de lead. Retorna uma matriz vazia se nenhum erro for detectado.
    Por exemplo:
    [
      {"email":"Invalid email address."},
      {"last_name":"Mandatory field is either missing or invalid."},
      {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
    ]

    Essas mensagens de erro estão localizadas em LeadAPIConstantsOOB inclusão de script.

    Tipo de dados: Matriz de objetos

    <JSON object>.indexesOfleadLineItemsForInsertion Índices de novos itens de linha de lead que precisam ser inseridos no leadObject.

    Tipo de dados: Matriz de números inteiros

    O exemplo de código a seguir mostra onde adicionar seu código personalizado para ValidateLeadObjectForPatchCall() método no LeadAPIValidationUtil inclusão de script.

    var LeadAPIValidationUtil = Class.create(); 
    
    LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 
    
    // Define overriding functions here
    
    validateLeadObjectForPatchCall: function(leadObject) { 
    // Add your custom code here
    }, 
    
    type: 'LeadAPIValidationUtil' 
    
    });

    LeadAPIValidationUtilOOB - validateLeadObjectForPostCall (objeto leadObject)

    Valida os campos aprovados para um lead especificado e seus itens de linha associados ao criar um registro de lead usando PUBLICAR endpoint do lead API.

    Este método é acionado pelo ProcessCreateLead() método no LeadAPIValidationUtilOOB inclusão de script. Este método executa várias validações, como:
    • Verifica se há campos obrigatórios.
    • Verifica se o número de telefone e o endereço de e-mail têm o formato adequado.
    • Verifica os campos de escolha e referência, ignorando todos os valores inválidos.
    Tabela 3. Parâmetros
    Nome Tipo Descrição
    LeadObject Objeto Campos a serem inseridos no novo registro de lead e nos registros de item de linha de lead associados. Para obter uma lista dos campos que podem ser aprovados e seus requisitos associados, consulte Lead - PUBLICAR /sn_lead_mgmt_core/lead.
    Tabela 4. Retornos
    Tipo Descrição
    Matriz Detalhes dos erros detectados ao validar o lead aprovado e o objeto de item de linha de lead. Retorna uma matriz vazia se nenhum erro for detectado.
    Por exemplo:
    [
      {"email":"Invalid email address."},
      {"last_name":"Mandatory field is either missing or invalid."},
      {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
    ]

    Essas mensagens de erro estão localizadas em LeadAPIConstantsOOB inclusão de script.

    O exemplo de código a seguir mostra onde adicionar seu código personalizado para ValidateLeadObjectForPostCall() método no LeadAPIValidationUtil inclusão de script.

    var LeadAPIValidationUtil = Class.create(); 
    
    LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 
    
    // Define overriding functions here 
    
    validateLeadObjectForPostCall: function(leadObject) { 
    // Add your custom code
    }, 
    
    type: 'LeadAPIValidationUtil' 
    
    });