API de lead

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 68 min. de leitura

    • A API de lead fornece endpoints que permitem criar, atualizar e consultar/recuperar leads de marketing e seus itens de linha de lead associados de uma instância.

    Use esta API para integrar sua instância com sites e sistemas externos, como sistemas automatizados de captura de lead, ou para fornecer informações de lead para sistemas de emissão de relatórios externos.

    Esta API é fornecida no namespace sn_lead_mgmt_core. Para acessar a API, o plug-in Lead Management Data Model (sn_lead_mgmt_core) deve ser ativado na instância e o usuário de chamada 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.

    Como estender a API do lead

    Você pode estender a API principal substituindo os métodos em suas inclusões de script associadas. A funcionalidade de API padrão está localizada em inclusões de script que terminam em "OOB", como LeadAPIProcessUtilOOB. Para substituir essa funcionalidade, crie métodos com nomes e parâmetros idênticos na inclusão de script que tenha o mesmo nome de arquivo, mas não termine em "OOB", como LeadAPIProcessUtil.

    A seguir está uma lista das inclusões de script que você pode substituir para mudar o comportamento da API lead :

    • LeadAPIProcessUtilOOB: contém métodos que lidam com a recuperação e a criação de registros de lead e de item de linha de lead.
    • LeadApiValidationUtilOOB: contém métodos que validam o objeto de solicitação JSON para os endpoints POST e PATCH.
    • LeadAPIHelperOOB: contém métodos de ajuda de API que:
      • Retornar uma matriz de leads e itens de linha de lead relacionados.
      • Retornar um objeto JSON do GlideRecord associado.
      • Remova todos os campos ignorados de um objeto JSON e execute outras transformações.
    • LeadAPIConstantsOOB: contém constantes, códigos de status e mensagens para todas as operações de API. Também inclui a lista de campos que são ignorados pelos endpoints POST e PATCH.

    lead – GET /sn_lead_mgmt_core/lead

    Recupera todos os leads e itens de linha de lead associados com base nos critérios de filtro passados nos parâmetros de consulta.

    Este endpoint retorna uma resposta paginada de acordo com o limite e deslocamento especificados. Ele recupera informações das seguintes tabelas:
    • Lead [sn_lead_mgmt_core_lead]
    • Item de linha de lead [sn_lead_mgmt_core_lead_line_item]

    Formato da URL

    URL com controle de versão: /api/sn_lead_mgmt_core/{api_version}/lead

    URL padrão: /api/sn_lead_mgmt_core/{api_version}/lead

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    sysparm_fields Lista separada por vírgulas de campos a serem retornados na resposta. Campos inválidos são ignorados.

    Tipo de dados: cadeia de caracteres

    Padrão: retornar todos os campos.
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    sysparm_query Consulta codificada usada para filtrar o conjunto de resultados.

    Por exemplo:

    (sysparm_query=caller_id=javascript:gs.getUserID()^active=true)

    A consulta codificada oferece suporte à ordem por. Para classificar respostas com base em determinados campos, use as cláusulas ORDERBY e ORDERBYDESC em sysparm_query. Por exemplo, sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory filtra todos os registros ativos e ordena os resultados em ordem crescente por número primeiro e, em seguida, em ordem decrescente por categoria.

    Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida.
    Nota:
    A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web.

    Tipo de dados: cadeia de caracteres
    Tabela 3. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Intervalo de conteúdo Intervalo de conteúdo retornado em uma chamada paginada.

    Por exemplo, se deslocamento=2 e limite=3, o valor do cabeçalho Content-Range será os itens 3-5.
    Links Links pelos quais é possível navegar pelos resultados da consulta:
    • primeiro
    • último
    • avançar
    • anterior
    • próprio
    Contagem total Número total de registros filtrados.

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 6. Códigos de status
    Código do status Descrição
    200 A solicitação foi processada com sucesso. Todas as respostas retornadas (sem paginação).
    206Solicitação processada com sucesso. Recurso parcial retornado em resposta (com paginação).
    400 Erro. Possíveis motivos:
    • Limite inválido/limite maior que o máximo permitido.
    • Deslocamento inválido.
    403 Acesso negado ao registro. Permissão insuficiente para consultar o registro.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação.

    Parâmetros do corpo da resposta

    Nome Descrição
    conta Conta vinculada ao lead.
    Tipo de dados: objeto
    "account": { 
  "name": "String",
  "sys_id": "String"
}
    conta.nome Nome da conta.

    Tipo de dados: cadeia de caracteres
    conta.sys_id
    Sys_id do registro de conta associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    business_phone Número de telefone comercial do lead.

    Tipo de dados: cadeia de caracteres
    cidade Cidade na qual o lead reside.

    Tipo de dados: cadeia de caracteres
    data_fechada Data e hora em que o lead foi encerrado.
    Tipo de dados: objeto
    "closed_date": {
  "display_value": "String", 
  "value": "String"
}
    closed_date.​display_value Data e hora exibidas na IU.

    Tipo de dados: cadeia de caracteres

    Formato: formato e fuso horário do usuário.
    closed_date.value Data e hora em que o lead foi encerrado conforme definido no registro associado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    empresa Nome da empresa do lead.

    Tipo de dados: cadeia de caracteres
    cliente Consumidor associado ao lead.

    Tipo de dados: objeto

    "consumer": {
  "name": "String",
  "sys_id": "String"
}
    consumer.name Nome do consumidor associado.

    Tipo de dados: cadeia de caracteres
    consumidor.sys_id
    Sys_id do registro do consumidor associado.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    contato Contato associado à conta principal.

    Tipo de dados: objeto

    "contact": {
  "name": "String",
  "sys_id": "String" 
}
    contato.nome Nome do contato.

    Tipo de dados: cadeia de caracteres
    contato.sys_id
    Sys_id do registro de contato associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    país País no qual o lead reside.

    Tipo de dados: cadeia de caracteres
    do_not_call
    Sinalizador que indica se o modo de comunicação é por telefone.
    Valores válidos:
    • verdadeiro: pode chamar o contato.
    • falso: não ligar para o contato.

    Tipo de dados: booliano
    do_not_email
    Sinalizador que indica se o modo de comunicação é por e-mail.
    Valores válidos:
    • verdadeiro: pode enviar e-mail para contato.
    • falso: não envie e-mail para o contato.

    Tipo de dados: booliano
    não_compartilhar
    Sinalizador que indica se os detalhes do lead podem ser compartilhados.
    Valores válidos:
    • verdadeiro: os detalhes do lead podem ser compartilhados.
    • falso: os detalhes do lead não podem ser compartilhados.

    Tipo de dados: booliano
    e-mail Endereço de e-mail do lead.

    Tipo de dados: cadeia de caracteres
    external_id ID usada pelo sistema que gerou o lead para identificar o lead no sistema associado.

    Tipo de dados: cadeia de caracteres
    sistema_externo Nome do sistema externo associado ao lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    first_name Nome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    setor Setor ao qual o lead pertence.

    Tipo de dados: cadeia de caracteres

    Tabela: localizada no campo industry da tabela Conta [customer_account].

    last_name
    Sobrenome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    lead_group
    Grupo ao qual o lead pertence.

    Tipo de dados: objeto

    "lead_group": {
  "name: "String",
  "sys_id": "String"
}
    lead_group.name Nome do grupo de leads.

    Tipo de dados: cadeia de caracteres
    lead_group.sys_id Sys_id do registro do grupo de leads.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    lead_line_items Detalhes dos itens de linha de lead associados ao lead.

    Tipo de dados: matriz de objetos

    "lead_line_items": [ 
  { 
    "external_id": "String", 
    "external_system": "String",
    "lead": {Object},
    "number": "String",
    "product_offering": {Object},
    "quantity": Number,
    "sys_created_by”: "String",
    "sys_created_on {Object},
    "sys_domain": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "sys_mod_count": Number,
    "sys_tags": [Array],
    "sys_updated_by: "String",
    "sys_updated_on: {Object},
    "unit_of_measurement": {Object}, 
    "work_notes": [Array]
  } 
]
    lead_line_items.​external_id ID usada pelo sistema que gerou o item de linha principal para identificar o item de linha no sistema associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​external_system Nome do sistema externo associado ao item de linha de lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​lead Detalhes sobre o lead associado ao item de linha.
    Tipo de dados: objeto
    "lead: {
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​lead.name Nome do lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​lead.sys_id Sys_id do registro de lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​number Número exclusivo gerado pelo sistema do registro do item de linha principal.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering Informações sobre a oferta de produto associada ao item de linha lead.

    Tipo de dados: objeto

    "product_offering": {
  "code": " String",
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​product_offering.code Código vinculado à oferta de produto.
    Nota:
    Este é um número alfanumérico gerado pelo sistema com base no nome do produto. Embora seja gerado pelo sistema, você pode editar o código para representar um SKU ou qualquer outro código de produto específico do setor.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering.name Nome da oferta do produto.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering.sys_id
    Sys_id do registro de oferta de produto associado ao item de linha lead.

    Tipo de dados: cadeia de caracteres

    Tabela: oferta de produto [sn_prd_pm_product_offering]
    lead_line_items.​quantidade
    Quantidade de itens que o lead deseja comprar da oferta de produto associada.

    Tipo de dados: número (inteiro)
    lead_line_items.​sys_created_by Nome de usuário da pessoa que criou o item de linha de lead.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_created_on Data e hora geradas pelo sistema em que o item de linha de lead foi criado.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    lead_line_items.​sys_created_on.display_value Data e hora em que o item de linha de lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    lead_line_items.​sys_created_on.value Data e hora em que o item de linha de lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    lead_line_items.​sys_domain Sys_id do registro de domínio ao qual o item de linha de lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.sys_domain_path Caminho do domínio ao qual o item de linha principal pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_id Sys_id do registro do item de linha principal.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_mod_count Número de vezes que o registro do item de linha de lead associado foi modificado.

    Tipo de dados: número (inteiro)
    lead_line_items.​sys_tags Lista de marcadores do sistema associados ao item de linha de lead.

    Tipo de dados: matriz
    lead_line_items.​sys_updated_by Nome de usuário da pessoa que atualizou pela última vez o item de linha de lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_updated_on Data e hora geradas pelo sistema em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    lead_line_items.​sys_updated_on.​display_value Data e hora em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    lead_line_items.​sys_updated_on.​value Data e hora em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    lead_line_items.​unit_of_measurement
    Detalhes da unidade de medida do item de linha de lead.

    Tipo de dados: objeto

    "unit_of_measurement": {
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​unit_of_measurement.​name Nome da unidade de medida, como cada ou pé cúbico.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​unit_of_measurement.​sys_id Sys_id do registro que descreve a unidade de medida.

    Tipo de dados: cadeia de caracteres

    Tabela: unidade de medida [sn_prd_pm_uom]
    lead_line_items.​work_notes
    Lista que descreve as anotações de trabalho criadas para o item de linha de lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "author": "String",
    "date": "String",
    "text": "String"
  }
]
    lead_line_items.​work_notes.​autor Nome de usuário da pessoa que criou a anotação de trabalho associada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​work_notes.​date Data em que a anotação foi criada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    lead_rating Classificação do lead, como 100_cold, 200_warm, 300_Hot ou 400_Super_Hot.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_rating da tabela Leads.

    Tipo de dados: cadeia de caracteres
    pontuação_lead Pontuação para o lead.

    Tipo de dados: decimal

    Intervalo: 1 a 100
    lead_source Originador do lead.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_source da tabela Leads.

    Tipo de dados: cadeia de caracteres
    lead_type
    Tipo de lead, como Novo negócio ou Negócio existente.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_type da tabela Leads.

    Tipo de dados: cadeia de caracteres
    middle_name Nome do meio do contato para o lead.

    Tipo de dados: cadeia de caracteres
    mobile_phone Número de telefone do contato do lead.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo do registro de lead gerado pelo sistema.

    Tipo de dados: cadeia de caracteres
    outro_razão Motivo adicional para a desqualificação do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    responsável
    Detalhes da pessoa associada ao lead.

    Tipo de dados: objeto

    "owner": {
  "name": "String",
  "sys_id": "String"
}
    owner.name Nome da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres
    proprietário.sys_id Sys_id do registro de usuário da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    motivo Motivo para a desqualificação do lead, como Desqualificar.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40 caracteres
    short_description Descrição resumida do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    lead_semelhante
    Detalhes sobre qualquer lead semelhante. Use isso para possível desqualificação de lead.

    Tipo de dados: objeto

    "similar_lead": {
  "name": "String",
  "sys_id": "String"
}
    lead_semelhante.nome Nome do lead duplicado.

    Tipo de dados: cadeia de caracteres
    lead_semelhante.sys_id Sys_id do registro de lead que é um possível lead duplicado.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    fase
    Fase do lead, como 100_new.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo de fase da tabela Leads.

    Tipo de dados: cadeia de caracteres
    estado Estado em que o lead reside.

    Tipo de dados: cadeia de caracteres
    rua Rua em que o lead reside.

    Tipo de dados: cadeia de caracteres
    sys_class_name Nome da classe de lead gerado pelo sistema.

    Tipo de dados: cadeia de caracteres
    sys_created_by Nome de usuário da pessoa que criou o lead.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora geradas pelo sistema em que o lead foi criado.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    sys_created_on.​display_value Data e hora em que o lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    sys_created_on.​valor Data e hora em que o lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    sys_domain Sys_id do registro de domínio ao qual o lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    sys_domain_path Caminho do domínio ao qual o lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do registro de lead.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    sys_mod_count Número de vezes que o registro de lead associado foi modificado.

    Tipo de dados: número (inteiro)
    sys_tags Lista de marcadores do sistema associados ao lead. Você pode usar esses marcadores para categorizar leads.

    Tipo de dados: matriz
    sys_updated_by Nome de usuário da pessoa que atualizou o registro de lead pela última vez.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora geradas pelo sistema em que o lead foi atualizado pela última vez.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    sys_updated_on.​display_value Data e hora em que o lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: formato e fuso horário padrão da instância
    sys_updated_on.​valor Data e hora em que o lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    título Título do lead.

    Tipo de dados: cadeia de caracteres
    site URL do site do lead.

    Tipo de dados: cadeia de caracteres
    notas_de_trabalho
    Lista de anotações de trabalho criadas para o lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "author": "String",
    "date": "String",
    "text": "String"
  }
]
    work_notes.​autor Nome de usuário da pessoa que criou a anotação de trabalho associada.

    Tipo de dados: cadeia de caracteres
    work_notes.​data Data em que a anotação foi criada.

    Tipo de dados: cadeia de caracteres
    work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    zip CEP do lead associado.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como passar parâmetros de consulta para especificar os leads a serem retornados.

    curl "https://instance.service-now.com/api/sn_lead_mgmt_core/lead?sysparm_query=stage%3D400_closed_won&sysparm_fields=sys_id%2Cfirst_name%2Clast_name%2Cshort_description%2Cstage%2Clead_line_items&sysparm_offset=2" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username":"password"

    Leads são retornados em uma matriz de objetos:

    [
  {
    "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
    "reason": null,
    "country": "USA",
    "closed_date": null,
    "city": "San Francisco",
    "lead_source": "inbound_phone",
    "external_id": null,
    "industry": "manufacturing",
    "sys_updated_on": {
      "value": "2024-05-31 11:01:55",
      "display_value": "2024-05-31 04:01:55"
    },
    "title": "Director of Building operations",
    "sys_class_name": "Lead",
    "number": "LEAD0000001",
    "sys_id": "856b6a95ffde8210b85dffffffffffd7",
    "business_phone": "+1 (555) 123-4567",
    "similar_lead": null,
    "sys_updated_by": "admin",
    "mobile_phone": null,
    "street": "789, Industrial drive",
    "sys_created_on": {
      "value": "2024-05-20 10:32:41",
      "display_value": "2024-05-20 03:32:41"
    },
    "contact": null,
    "company": "Lee Manufacturing Inc",
    "state": "CA",
    "first_name": "James",
    "email": "james.wilson@email.com",
    "consumer": null,
    "sys_created_by": "admin",
    "zip": "94016",
    "owner": {
      "sys_id": "60058fe943fe3110d6c6cd60afb8f203",
      "name": "Max Blaze"
    },
    "website": null,
    "lead_group": null,
    "sys_mod_count": 1,
    "last_name": "Wilson",
    "other_reason": null,
    "middle_name": null,
    "sys_tags": null,
    "do_not_share": false,
    "lead_score": 92,
    "stage": "300_nurturing",
    "do_not_email": false,
    "lead_type": null,
    "work_notes": [
      {
        "author": "Abel Tuter",
        "date": "2024-12-04 06:52:07",
        "text": "Work notes for lead"
      }
    ],
    "do_not_call": false,
    "lead_rating": "400_super_hot",
    "account": null,
    "external_system": null,
    "lead_line_items": [
      {
        "quantity": 6,
        "product_offering": {
          "sys_id": "32619d9fd0a63110f8770dbf976be1f9",
          "name": "Safety Test Coverage",
          "code": "SAFETSTCVG1"
        },
        "sys_mod_count": 0,
        "external_id": null,
        "sys_updated_on": {
          "value": "2024-05-20 10:38:41",
          "display_value": "2024-05-20 03:38:41"
        },
        "sys_tags": null,
        "lead": {
          "sys_id": "856b6a95ffde8210b85dffffffffffd7",
          "name": "LEAD0000001"
        },
        "number": "LEADL0000003",
        "sys_id": "013daa19ffde8210b85dffffffffff82",
        "unit_of_measurement": {
          "sys_id": "cb2795d553020110286eddeeff7b12ff",
          "name": "Each"
        },
        "sys_updated_by": "admin",
        "sys_created_on": {
          "value": "2024-05-20 10:38:41",
          "display_value": "2024-05-20 03:38:41"
        },
        "work_notes": null,
        "sys_created_by": "admin",
        "external_system": null
      }
    ]
  },
  {
    "short_description": "Partner referral for a company interested in a reliable internet bundle with strong security features for their office.",
    "reason": null,
    "country": "USA",
    "closed_date": null,
    "city": "San Francisco",
    "lead_source": "partner_referral",
    "external_id": null,
    "industry": "technology_services",
    "sys_updated_on": {
      "value": "2024-05-20 10:53:59",
      "display_value": "2024-05-20 03:53:59"
    },
    "title": "IT Director",
    "sys_class_name": "Lead",
    "number": "LEAD0000002",
    "sys_id": "e71fa6d9ffde8210b85dffffffffff51",
    "business_phone": "(626) 722-6969",
    "similar_lead": null,
    "sys_updated_by": "admin",
    "mobile_phone": null,
    "street": "747 Howard St",
    "sys_created_on": {
      "value": "2024-05-20 10:49:12",
      "display_value": "2024-05-20 03:49:12"
    },
    "contact": {
      "sys_id": "4d147a386f0331003b3c498f5d3ee437",
      "name": ""
    },
    "company": "Boxeo",
    "state": "CA",
    "first_name": "Julie",
    "email": "julie.lewis@example.com",
    "consumer": null,
    "sys_created_by": "admin",
    "zip": "94013",
    "owner": {
      "sys_id": "60058fe943fe3110d6c6cd60afb8f203",
      "name": "Max Blaze"
    },
    "website": null,
    "lead_group": null,
    "sys_mod_count": 0,
    "last_name": "Lewis",
    "other_reason": null,
    "middle_name": null,
    "sys_tags": null,
    "do_not_share": false,
    "lead_score": 78,
    "stage": "400_closed_won",
    "do_not_email": false,
    "lead_type": null,
    "work_notes": [
      {
        "author": "Abel Tuter",
        "date": "2024-12-03 03:52:51",
        "text": "Work noted for LEAD0000002"
      }
    ],
    "do_not_call": false,
    "lead_rating": "200_warm",
    "account": {
      "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
      "name": ""
    },
    "external_system": null,
    "lead_line_items": [
      {
        "quantity": 50,
        "product_offering": {
          "sys_id": "0b61dd9fd0a63110f8770dbf976be171",
          "name": "Solana Modem M Series",
          "code": "SOLANAMODE2"
        },
        "sys_mod_count": 0,
        "external_id": null,
        "sys_updated_on": { 
          "value": "2024-05-20 10:51:57",
          "display_value": "2024-05-20 03:51:57"
        },
        "sys_tags": null,
        "lead": {
          "sys_id": "e71fa6d9ffde8210b85dffffffffff51",
          "name": "LEAD0000002"
        },
        "number": "LEADL0000009",
        "sys_id": "2130fa1dffde8210b85dffffffffffff",
        "unit_of_measurement": {
          "sys_id": "cb2795d553020110286eddeeff7b12ff",
          "name": "Each"
        },
        "sys_updated_by": "admin",
        "sys_created_on": { 
          "value": "2024-05-20 10:51:25", 
          "display_value": "2024-05-20 03:51:25"
        },
        "work_notes": null,
        "sys_created_by": "admin",
        "external_system": null
      } 
    ]
  }
]

    lead – GET /sn_lead_mgmt_core/lead/{sys_id}

    Retorna o registro de lead e todos os itens de linha de lead associados para o sys_id especificado.

    Este endpoint recupera informações das seguintes tabelas:
    • Lead [sn_lead_mgmt_core_lead]
    • Item de linha de lead [sn_lead_mgmt_core_lead_line_item]

    Formato da URL

    URL com controle de versões: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

    URL padrão: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do lead a ser recuperado.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    conta Conta vinculada ao lead.
    Tipo de dados: objeto
    "account": { 
  "name": "String",
  "sys_id": "String"
}
    conta.nome Nome da conta.

    Tipo de dados: cadeia de caracteres
    conta.sys_id
    Sys_id do registro de conta associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    business_phone Número de telefone comercial do lead.

    Tipo de dados: cadeia de caracteres
    cidade Cidade na qual o lead reside.

    Tipo de dados: cadeia de caracteres
    data_fechada Data e hora em que o lead foi encerrado.
    Tipo de dados: objeto
    "closed_date": {
  "display_value": "String", 
  "value": "String"
}
    closed_date.​display_value Data e hora exibidas na IU.

    Tipo de dados: cadeia de caracteres

    Formato: formato e fuso horário do usuário.
    closed_date.value Data e hora em que o lead foi encerrado conforme definido no registro associado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    empresa Nome da empresa do lead.

    Tipo de dados: cadeia de caracteres
    cliente Consumidor associado ao lead.

    Tipo de dados: objeto

    "consumer": {
  "name": "String",
  "sys_id": "String"
}
    consumer.name Nome do consumidor associado.

    Tipo de dados: cadeia de caracteres
    consumidor.sys_id
    Sys_id do registro do consumidor associado.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    contato Contato associado à conta principal.

    Tipo de dados: objeto

    "contact": {
  "name": "String",
  "sys_id": "String" 
}
    contato.nome Nome do contato.

    Tipo de dados: cadeia de caracteres
    contato.sys_id
    Sys_id do registro de contato associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    país País no qual o lead reside.

    Tipo de dados: cadeia de caracteres
    do_not_call
    Sinalizador que indica se o modo de comunicação é por telefone.
    Valores válidos:
    • verdadeiro: pode chamar o contato.
    • falso: não ligar para o contato.

    Tipo de dados: booliano
    do_not_email
    Sinalizador que indica se o modo de comunicação é por e-mail.
    Valores válidos:
    • verdadeiro: pode enviar e-mail para contato.
    • falso: não envie e-mail para o contato.

    Tipo de dados: booliano
    não_compartilhar
    Sinalizador que indica se os detalhes do lead podem ser compartilhados.
    Valores válidos:
    • verdadeiro: os detalhes do lead podem ser compartilhados.
    • falso: os detalhes do lead não podem ser compartilhados.

    Tipo de dados: booliano
    e-mail Endereço de e-mail do lead.

    Tipo de dados: cadeia de caracteres
    external_id ID usada pelo sistema que gerou o lead para identificar o lead no sistema associado.

    Tipo de dados: cadeia de caracteres
    sistema_externo Nome do sistema externo associado ao lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    first_name Nome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    setor Setor ao qual o lead pertence.

    Tipo de dados: cadeia de caracteres

    Tabela: localizada no campo industry da tabela Conta [customer_account].

    last_name
    Sobrenome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    lead_group
    Grupo ao qual o lead pertence.

    Tipo de dados: objeto

    "lead_group": {
  "name: "String",
  "sys_id": "String"
}
    lead_group.name Nome do grupo de leads.

    Tipo de dados: cadeia de caracteres
    lead_group.sys_id Sys_id do registro do grupo de leads.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    lead_line_items Detalhes dos itens de linha de lead associados ao lead.

    Tipo de dados: matriz de objetos

    "lead_line_items": [ 
  { 
    "external_id": "String", 
    "external_system": "String",
    "lead": {Object},
    "number": "String",
    "product_offering": {Object},
    "quantity": Number,
    "sys_created_by”: "String",
    "sys_created_on {Object},
    "sys_domain": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "sys_mod_count": Number,
    "sys_tags": [Array],
    "sys_updated_by: "String",
    "sys_updated_on: {Object},
    "unit_of_measurement": {Object}, 
    "work_notes": [Array]
  } 
]
    lead_line_items.​external_id ID usada pelo sistema que gerou o item de linha principal para identificar o item de linha no sistema associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​external_system Nome do sistema externo associado ao item de linha de lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​lead Detalhes sobre o lead associado ao item de linha.
    Tipo de dados: objeto
    "lead: {
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​lead.name Nome do lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​lead.sys_id Sys_id do registro de lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​number Número exclusivo gerado pelo sistema do registro do item de linha principal.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering Informações sobre a oferta de produto associada ao item de linha lead.

    Tipo de dados: objeto

    "product_offering": {
  "code": " String",
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​product_offering.code Código vinculado à oferta de produto.
    Nota:
    Este é um número alfanumérico gerado pelo sistema com base no nome do produto. Embora seja gerado pelo sistema, você pode editar o código para representar um SKU ou qualquer outro código de produto específico do setor.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering.name Nome da oferta do produto.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering.sys_id
    Sys_id do registro de oferta de produto associado ao item de linha lead.

    Tipo de dados: cadeia de caracteres

    Tabela: oferta de produto [sn_prd_pm_product_offering]
    lead_line_items.​quantidade
    Quantidade de itens que o lead deseja comprar da oferta de produto associada.

    Tipo de dados: número (inteiro)
    lead_line_items.​sys_created_by Nome de usuário da pessoa que criou o item de linha de lead.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_created_on Data e hora geradas pelo sistema em que o item de linha de lead foi criado.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    lead_line_items.​sys_created_on.display_value Data e hora em que o item de linha de lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    lead_line_items.​sys_created_on.value Data e hora em que o item de linha de lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    lead_line_items.​sys_domain Sys_id do registro de domínio ao qual o item de linha de lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.sys_domain_path Caminho do domínio ao qual o item de linha principal pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_id Sys_id do registro do item de linha principal.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_mod_count Número de vezes que o registro do item de linha de lead associado foi modificado.

    Tipo de dados: número (inteiro)
    lead_line_items.​sys_tags Lista de marcadores do sistema associados ao item de linha de lead.

    Tipo de dados: matriz
    lead_line_items.​sys_updated_by Nome de usuário da pessoa que atualizou pela última vez o item de linha de lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_updated_on Data e hora geradas pelo sistema em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    lead_line_items.​sys_updated_on.​display_value Data e hora em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    lead_line_items.​sys_updated_on.​value Data e hora em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    lead_line_items.​unit_of_measurement
    Detalhes da unidade de medida do item de linha de lead.

    Tipo de dados: objeto

    "unit_of_measurement": {
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​unit_of_measurement.​name Nome da unidade de medida, como cada ou pé cúbico.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​unit_of_measurement.​sys_id Sys_id do registro que descreve a unidade de medida.

    Tipo de dados: cadeia de caracteres

    Tabela: unidade de medida [sn_prd_pm_uom]
    lead_line_items.​work_notes
    Lista que descreve as anotações de trabalho criadas para o item de linha de lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "author": "String",
    "date": "String",
    "text": "String"
  }
]
    lead_line_items.​work_notes.​autor Nome de usuário da pessoa que criou a anotação de trabalho associada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​work_notes.​date Data em que a anotação foi criada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    lead_rating Classificação do lead, como 100_cold, 200_warm, 300_Hot ou 400_Super_Hot.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_rating da tabela Leads.

    Tipo de dados: cadeia de caracteres
    pontuação_lead Pontuação para o lead.

    Tipo de dados: decimal

    Intervalo: 1 a 100
    lead_source Originador do lead.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_source da tabela Leads.

    Tipo de dados: cadeia de caracteres
    lead_type
    Tipo de lead, como Novo negócio ou Negócio existente.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_type da tabela Leads.

    Tipo de dados: cadeia de caracteres
    middle_name Nome do meio do contato para o lead.

    Tipo de dados: cadeia de caracteres
    mobile_phone Número de telefone do contato do lead.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo do registro de lead gerado pelo sistema.

    Tipo de dados: cadeia de caracteres
    outro_razão Motivo adicional para a desqualificação do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    responsável
    Detalhes da pessoa associada ao lead.

    Tipo de dados: objeto

    "owner": {
  "name": "String",
  "sys_id": "String"
}
    owner.name Nome da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres
    proprietário.sys_id Sys_id do registro de usuário da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    motivo Motivo para a desqualificação do lead, como Desqualificar.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40 caracteres
    short_description Descrição resumida do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    lead_semelhante
    Detalhes sobre qualquer lead semelhante. Use isso para possível desqualificação de lead.

    Tipo de dados: objeto

    "similar_lead": {
  "name": "String",
  "sys_id": "String"
}
    lead_semelhante.nome Nome do lead duplicado.

    Tipo de dados: cadeia de caracteres
    lead_semelhante.sys_id Sys_id do registro de lead que é um possível lead duplicado.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    fase
    Fase do lead, como 100_new.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo de fase da tabela Leads.

    Tipo de dados: cadeia de caracteres
    estado Estado em que o lead reside.

    Tipo de dados: cadeia de caracteres
    rua Rua em que o lead reside.

    Tipo de dados: cadeia de caracteres
    sys_class_name Nome da classe de lead gerado pelo sistema.

    Tipo de dados: cadeia de caracteres
    sys_created_by Nome de usuário da pessoa que criou o lead.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora geradas pelo sistema em que o lead foi criado.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    sys_created_on.​display_value Data e hora em que o lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    sys_created_on.​valor Data e hora em que o lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    sys_domain Sys_id do registro de domínio ao qual o lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    sys_domain_path Caminho do domínio ao qual o lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do registro de lead.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    sys_mod_count Número de vezes que o registro de lead associado foi modificado.

    Tipo de dados: número (inteiro)
    sys_tags Lista de marcadores do sistema associados ao lead. Você pode usar esses marcadores para categorizar leads.

    Tipo de dados: matriz
    sys_updated_by Nome de usuário da pessoa que atualizou o registro de lead pela última vez.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora geradas pelo sistema em que o lead foi atualizado pela última vez.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    sys_updated_on.​display_value Data e hora em que o lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: formato e fuso horário padrão da instância
    sys_updated_on.​valor Data e hora em que o lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    título Título do lead.

    Tipo de dados: cadeia de caracteres
    site URL do site do lead.

    Tipo de dados: cadeia de caracteres
    notas_de_trabalho
    Lista de anotações de trabalho criadas para o lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "author": "String",
    "date": "String",
    "text": "String"
  }
]
    work_notes.​autor Nome de usuário da pessoa que criou a anotação de trabalho associada.

    Tipo de dados: cadeia de caracteres
    work_notes.​data Data em que a anotação foi criada.

    Tipo de dados: cadeia de caracteres
    work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    zip CEP do lead associado.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como recuperar o registro de lead com o sys_id de 856b6a95ffde8210b85dffffffffffd7.

    curl "https://instance.service-now.com /api/sn_lead_mgmt_core/lead/856b6a95ffde8210b85dffffffffffd7" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username":"password"

    Estes são os resultados de retorno:

    { 
  "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
  "reason": null,
  "country": "USA",
  "closed_date": null,
  "city": "San Francisco",
  "lead_source": "inbound_phone",
  "external_id": null,
  "industry": "manufacturing",
  "sys_updated_on": {
    "value": "2024-05-31 11:01:55",
    "display_value": "2024-05-31 04:01:55"
  },
  "title": "Director of Building operations",
  "sys_class_name": "Lead",
  "number": "LEAD0000001",
  "sys_id": "856b6a95ffde8210b85dffffffffffd7",
  "business_phone": "+1 (555) 123-4567",
  "similar_lead": null,
  "sys_updated_by": "abel.tuter",
  "mobile_phone": null,
  "street": "789, Industrial drive",
  "sys_created_on": {
    "value": "2024-05-20 10:32:41",
    "display_value": "2024-05-20 03:32:41"
  },
  "contact": null,
  "company": "Lee Manufacturing Inc",
  "state": "CA",
  "first_name": "James",
  "email": "james.wilson@email.com",
  "consumer": null,
  "sys_created_by": "abel.tuter",
  "zip": "94016",
  "owner": {
    "sys_id": "60058fe943fe3110d6c6cd60afb8f203",
    "name": "Max Blaze"
  },
  "website": null,
  "lead_group": null,
  "sys_mod_count": 1,
  "last_name": "Wilson",
  "other_reason": null,
  "middle_name": null,
  "sys_tags": null,
  "do_not_share": false,
  "lead_score": 92,
  "stage": "300_nurturing",
  "do_not_email": false,
  "lead_type": null,
  "work_notes": [
    {
      "author": "Abel Tuter",
      "date": "2024-12-04 06:52:07",
      "text": "Work notes for lead" 
    }
  ],
  "do_not_call": false,
  "lead_rating": "400_super_hot",
  "account": null,
  "external_system": null, 
  "lead_line_items": [
    {
      "quantity": 6,
      "product_offering": {
        "sys_id": "32619d9fd0a63110f8770dbf976be1f9",
        "name": "Safety Test Coverage",
        "code": "SAFETSTCVG1"
      },
      "sys_mod_count": 0,
      "external_id": null,
      "sys_updated_on": {
        "value": "2024-05-20 10:38:41",
        "display_value": "2024-05-20 03:38:41" 
      },
      "sys_tags": null,
      "lead": {
        "sys_id": "856b6a95ffde8210b85dffffffffffd7",
        "name": "LEAD0000001"
      },
      "number": "LEADL0000003", 
      "sys_id": "013daa19ffde8210b85dffffffffff82",
      "unit_of_measurement": { 
        "sys_id": "cb2795d553020110286eddeeff7b12ff",
        "name": "Each"
      },
      "sys_updated_by": "abel.tuter",
      "sys_created_on": {
        "value": "2024-05-20 10:38:41",
        "display_value": "2024-05-20 03:38:41"
      },
      "work_notes": null,
      "sys_created_by": "abel.tuter",
      "external_system": null
    }
  ]
}

    lead – PATCH /sn_lead_mgmt_core/lead/{sys_id}

    Atualiza o registro de lead especificado e os itens de linha de lead associados. Você também pode usar este endpoint para associar novos itens de linha de lead ao lead especificado.

    Este endpoint atualiza informações nas seguintes tabelas:
    • Lead [sn_lead_mgmt_core_lead]
    • Item de linha de lead [sn_lead_mgmt_core_lead_line_item]
    Regras para parâmetros passados:
    • Nomes de parâmetro inválidos são ignorados.
    • Valores inválidos para opções não obrigatórias e campos de referência são ignorados.
    • Se o acesso ao campo WRITE for negado para um ou mais campos, os campos restritos serão ignorados.
    • Você não pode inserir valores de campo do sistema usando esta API. Todos os valores fornecidos são ignorados. Os campos do sistema fazem parte da lista de campos ignorados, que é configurável.
    • Os valores dos parâmetros account, contacte consumer serão ignorados se os parâmetros account e consumer não estiverem vazios.
    • A menos que seja especificado de outra forma, o valor padrão para todos os parâmetros não aprovados é "nulo".
    Nota:
    Este endpoint modifica somente os parâmetros especificados. Se um parâmetro que existe no lead atual ou no registro de item de linha de lead não for especificado na chamada, seu conteúdo permanecerá inalterado.

    Formato da URL

    URL com controle de versão: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

    URL padrão: /api/sn_lead_mgmt_core/{api_version}/lead/{sys_id}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do registro de lead a ser atualizado.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Parâmetros do corpo da solicitação
    Nome Descrição
    conta Detalhes da conta associada ao lead.
    Tipo de dados: objeto
    "account": {
  "sys_id": "String"
}
    conta.sys_id
    Sys_id do registro de conta associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    business_phone Número de telefone comercial do lead.

    Tipo de dados: cadeia de caracteres
    cidade Cidade na qual o lead reside.

    Tipo de dados: cadeia de caracteres
    empresa Nome da empresa do lead.

    Tipo de dados: cadeia de caracteres
    cliente Consumidor associado ao lead.

    Tipo de dados: objeto

    "consumer": { 
  "sys_id": "String" 
}
    consumidor.sys_id
    Sys_id do registro do consumidor associado.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    contato Contato associado à conta principal.

    Tipo de dados: objeto

    "contact": { 
  "sys_id": "String" 
}
    contato.sys_id
    Sys_id do registro de contato associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    país País no qual o lead reside.

    Tipo de dados: cadeia de caracteres
    do_not_call
    Sinalizador que indica se o modo de comunicação é por telefone.
    Valores válidos:
    • verdadeiro: pode chamar o contato.
    • falso: não ligar para o contato.

    Tipo de dados: booliano
    do_not_email
    Sinalizador que indica se o modo de comunicação é por e-mail.
    Valores válidos:
    • verdadeiro: pode enviar e-mail para contato.
    • falso: não envie e-mail para o contato.

    Tipo de dados: booliano
    não_compartilhar
    Sinalizador que indica se os detalhes do lead podem ser compartilhados.
    Valores válidos:
    • verdadeiro: os detalhes do lead podem ser compartilhados.
    • falso: os detalhes do lead não podem ser compartilhados.

    Tipo de dados: booliano
    e-mail Endereço de e-mail do lead.

    Tipo de dados: cadeia de caracteres
    external_id ID usada pelo sistema que gerou o lead para identificar o lead no sistema associado.

    Tipo de dados: cadeia de caracteres
    sistema_externo Nome do sistema externo associado ao lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    first_name Nome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    setor Setor ao qual o lead pertence.

    Tipo de dados: cadeia de caracteres

    Tabela: localizada no campo industry da tabela Conta [customer_account].

    last_name Obrigatório.
    Sobrenome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    lead_group
    Grupo ao qual o lead pertence.

    Tipo de dados: objeto

    "lead_group": {
  "sys_id": "String"
}
    lead_group.sys_id Sys_id do registro do grupo de leads.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    lead_line_items Lista de itens de linha de lead a serem associados ao lead.
    Grupo ao qual o lead pertence.

    Tipo de dados: objeto

    "lead_line_items": [ 
  { 
    "external_id": "String",
    "external_system": "String",
    "product_offering": {Object},
    "quantity": Number, 
    "work_notes": [Array],
    "unit_of_measurement": {Object} 
  } 
]

    Máximo de itens de linha: 100 - qualquer item a mais será ignorado
    lead_line_items.​external_id ID usada pelo sistema que gerou o item de linha principal para identificar o item de linha no sistema associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​external_system Nome do sistema externo associado ao item de linha de lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    lead_line_items.product_offering Obrigatório. Informações sobre a oferta de produto associada ao item de linha lead.

    Tipo de dados: objeto

    "product_offering": {
  "sys_id": "String"
}
    lead_line_items.product_offering.sys_id Obrigatório.
    Sys_id do registro de oferta de produto associado ao item de linha lead.

    Tipo de dados: cadeia de caracteres

    Tabela: oferta de produto [sn_prd_pm_product_offering]
    lead_line_items.quantidade
    Quantidade de itens que o lead deseja comprar da oferta de produto associada.

    Tipo de dados: número (inteiro)
    lead_line_items.​unit_of_measurement
    Detalhes da unidade de medida do item de linha de lead.

    Tipo de dados: objeto

    "unit_of_measurement": {
  "sys_id": "String"
}
    lead_line_items.​unit_of_measurement​.sys_id Sys_id do registro que descreve a unidade de medida.

    Tipo de dados: cadeia de caracteres

    Tabela: unidade de medida [sn_prd_pm_uom]
    lead_line_items.work_notes
    Lista que descreve as anotações de trabalho criadas para o item de linha de lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
    "text": "String"
  }
]
    lead_line_items.​work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    lead_rating Classificação do lead, como 100_cold, 200_warm, 300_Hot ou 400_Super_Hot.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_rating da tabela Leads.

    Tipo de dados: cadeia de caracteres
    pontuação_lead Pontuação para o lead.

    Tipo de dados: decimal

    Intervalo: 1 a 100
    lead_source Originador do lead.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_source da tabela Leads.

    Tipo de dados: cadeia de caracteres
    lead_type
    Tipo de lead, como Novo negócio ou Negócio existente.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_type da tabela Leads.

    Tipo de dados: cadeia de caracteres
    middle_name Nome do meio do contato para o lead.

    Tipo de dados: cadeia de caracteres
    mobile_phone Número de telefone do contato do lead.

    Tipo de dados: cadeia de caracteres
    outro_razão Motivo adicional para a desqualificação do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    responsável
    Detalhes da pessoa associada ao lead.

    Tipo de dados: objeto

    "owner": {
  "sys_id": "String"
}
    proprietário.sys_id Sys_id do registro de usuário da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    motivo Motivo para a desqualificação do lead, como Desqualificar.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40 caracteres
    short_description Descrição resumida do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    lead_semelhante
    Detalhes sobre qualquer lead semelhante. Use isso para possível desqualificação de lead.

    Tipo de dados: objeto

    "similar_lead": {
  "sys_id": "String"
}
    lead_semelhante.sys_id Sys_id do registro de lead que é um possível lead duplicado.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    fase
    Fase do lead, como 100_new.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo de fase da tabela Leads.

    Tipo de dados: cadeia de caracteres
    estado Estado em que o lead reside.

    Tipo de dados: cadeia de caracteres
    rua Rua em que o lead reside.

    Tipo de dados: cadeia de caracteres
    título Título do lead.

    Tipo de dados: cadeia de caracteres
    site URL do site do lead.

    Tipo de dados: cadeia de caracteres
    notas_de_trabalho
    Lista de anotações de trabalho criadas para o lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "text": "String"
  }
]
    Nota:
    Uma matriz de anotações de trabalho na solicitação é inserida como um único texto. Este texto é gerado pela combinação do conteúdo de todos os objetos de anotação de trabalho na solicitação, com cada entrada separada por uma vírgula (,).
    work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    zip CEP do lead associado.

    Tipo de dados: cadeia de caracteres

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 18. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. Os registros de lead e itens de linha de lead foram atualizados com sucesso.
    400 Erro. Possíveis motivos:
    • Carga inválida: corpo da solicitação inválido/vazio.
    • Carga inválida: valor de campo inválido para campos de e-mail/número de telefone.
    • Carga inválida: o campo obrigatório está ausente ou seu valor está vazio.
    • Carga inválida: a fase é '400_closed_won'. O lead qualificado não é compatível com o uso da API.
    • Se a fase do lead a ser atualizada já estiver no estado fechado e você estiver tentando atualizá-la.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    conta Conta vinculada ao lead.
    Tipo de dados: objeto
    "account": { 
  "name": "String",
  "sys_id": "String"
}
    conta.nome Nome da conta.

    Tipo de dados: cadeia de caracteres
    conta.sys_id
    Sys_id do registro de conta associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    business_phone Número de telefone comercial do lead.

    Tipo de dados: cadeia de caracteres
    cidade Cidade na qual o lead reside.

    Tipo de dados: cadeia de caracteres
    data_fechada Data e hora em que o lead foi encerrado.
    Tipo de dados: objeto
    "closed_date": {
  "display_value": "String", 
  "value": "String"
}
    closed_date.​display_value Data e hora exibidas na IU.

    Tipo de dados: cadeia de caracteres

    Formato: formato e fuso horário do usuário.
    closed_date.value Data e hora em que o lead foi encerrado conforme definido no registro associado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    empresa Nome da empresa do lead.

    Tipo de dados: cadeia de caracteres
    cliente Consumidor associado ao lead.

    Tipo de dados: objeto

    "consumer": {
  "name": "String",
  "sys_id": "String"
}
    consumer.name Nome do consumidor associado.

    Tipo de dados: cadeia de caracteres
    consumidor.sys_id
    Sys_id do registro do consumidor associado.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    contato Contato associado à conta principal.

    Tipo de dados: objeto

    "contact": {
  "name": "String",
  "sys_id": "String" 
}
    contato.nome Nome do contato.

    Tipo de dados: cadeia de caracteres
    contato.sys_id
    Sys_id do registro de contato associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    país País no qual o lead reside.

    Tipo de dados: cadeia de caracteres
    do_not_call
    Sinalizador que indica se o modo de comunicação é por telefone.
    Valores válidos:
    • verdadeiro: pode chamar o contato.
    • falso: não ligar para o contato.

    Tipo de dados: booliano
    do_not_email
    Sinalizador que indica se o modo de comunicação é por e-mail.
    Valores válidos:
    • verdadeiro: pode enviar e-mail para contato.
    • falso: não envie e-mail para o contato.

    Tipo de dados: booliano
    não_compartilhar
    Sinalizador que indica se os detalhes do lead podem ser compartilhados.
    Valores válidos:
    • verdadeiro: os detalhes do lead podem ser compartilhados.
    • falso: os detalhes do lead não podem ser compartilhados.

    Tipo de dados: booliano
    e-mail Endereço de e-mail do lead.

    Tipo de dados: cadeia de caracteres
    external_id ID usada pelo sistema que gerou o lead para identificar o lead no sistema associado.

    Tipo de dados: cadeia de caracteres
    sistema_externo Nome do sistema externo associado ao lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    first_name Nome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    setor Setor ao qual o lead pertence.

    Tipo de dados: cadeia de caracteres

    Tabela: localizada no campo industry da tabela Conta [customer_account].

    last_name
    Sobrenome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    lead_group
    Grupo ao qual o lead pertence.

    Tipo de dados: objeto

    "lead_group": {
  "name: "String",
  "sys_id": "String"
}
    lead_group.name Nome do grupo de leads.

    Tipo de dados: cadeia de caracteres
    lead_group.sys_id Sys_id do registro do grupo de leads.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    lead_line_items Detalhes dos itens de linha de lead associados ao lead.

    Tipo de dados: matriz de objetos

    "lead_line_items": [ 
  { 
    "external_id": "String", 
    "external_system": "String",
    "lead": {Object},
    "number": "String",
    "product_offering": {Object},
    "quantity": Number,
    "sys_created_by”: "String",
    "sys_created_on {Object},
    "sys_domain": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "sys_mod_count": Number,
    "sys_tags": [Array],
    "sys_updated_by: "String",
    "sys_updated_on: {Object},
    "unit_of_measurement": {Object}, 
    "work_notes": [Array]
  } 
]
    lead_line_items.​external_id ID usada pelo sistema que gerou o item de linha principal para identificar o item de linha no sistema associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​external_system Nome do sistema externo associado ao item de linha de lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​lead Detalhes sobre o lead associado ao item de linha.
    Tipo de dados: objeto
    "lead: {
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​lead.name Nome do lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​lead.sys_id Sys_id do registro de lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​number Número exclusivo gerado pelo sistema do registro do item de linha principal.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering Informações sobre a oferta de produto associada ao item de linha lead.

    Tipo de dados: objeto

    "product_offering": {
  "code": " String",
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​product_offering.code Código vinculado à oferta de produto.
    Nota:
    Este é um número alfanumérico gerado pelo sistema com base no nome do produto. Embora seja gerado pelo sistema, você pode editar o código para representar um SKU ou qualquer outro código de produto específico do setor.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering.name Nome da oferta do produto.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering.sys_id
    Sys_id do registro de oferta de produto associado ao item de linha lead.

    Tipo de dados: cadeia de caracteres

    Tabela: oferta de produto [sn_prd_pm_product_offering]
    lead_line_items.​quantidade
    Quantidade de itens que o lead deseja comprar da oferta de produto associada.

    Tipo de dados: número (inteiro)
    lead_line_items.​sys_created_by Nome de usuário da pessoa que criou o item de linha de lead.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_created_on Data e hora geradas pelo sistema em que o item de linha de lead foi criado.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    lead_line_items.​sys_created_on.display_value Data e hora em que o item de linha de lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    lead_line_items.​sys_created_on.value Data e hora em que o item de linha de lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    lead_line_items.​sys_domain Sys_id do registro de domínio ao qual o item de linha de lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.sys_domain_path Caminho do domínio ao qual o item de linha principal pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_id Sys_id do registro do item de linha principal.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_mod_count Número de vezes que o registro do item de linha de lead associado foi modificado.

    Tipo de dados: número (inteiro)
    lead_line_items.​sys_tags Lista de marcadores do sistema associados ao item de linha de lead.

    Tipo de dados: matriz
    lead_line_items.​sys_updated_by Nome de usuário da pessoa que atualizou pela última vez o item de linha de lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_updated_on Data e hora geradas pelo sistema em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    lead_line_items.​sys_updated_on.​display_value Data e hora em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    lead_line_items.​sys_updated_on.​value Data e hora em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    lead_line_items.​unit_of_measurement
    Detalhes da unidade de medida do item de linha de lead.

    Tipo de dados: objeto

    "unit_of_measurement": {
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​unit_of_measurement.​name Nome da unidade de medida, como cada ou pé cúbico.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​unit_of_measurement.​sys_id Sys_id do registro que descreve a unidade de medida.

    Tipo de dados: cadeia de caracteres

    Tabela: unidade de medida [sn_prd_pm_uom]
    lead_line_items.​work_notes
    Lista que descreve as anotações de trabalho criadas para o item de linha de lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "author": "String",
    "date": "String",
    "text": "String"
  }
]
    lead_line_items.​work_notes.​autor Nome de usuário da pessoa que criou a anotação de trabalho associada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​work_notes.​date Data em que a anotação foi criada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    lead_rating Classificação do lead, como 100_cold, 200_warm, 300_Hot ou 400_Super_Hot.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_rating da tabela Leads.

    Tipo de dados: cadeia de caracteres
    pontuação_lead Pontuação para o lead.

    Tipo de dados: decimal

    Intervalo: 1 a 100
    lead_source Originador do lead.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_source da tabela Leads.

    Tipo de dados: cadeia de caracteres
    lead_type
    Tipo de lead, como Novo negócio ou Negócio existente.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_type da tabela Leads.

    Tipo de dados: cadeia de caracteres
    middle_name Nome do meio do contato para o lead.

    Tipo de dados: cadeia de caracteres
    mobile_phone Número de telefone do contato do lead.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo do registro de lead gerado pelo sistema.

    Tipo de dados: cadeia de caracteres
    outro_razão Motivo adicional para a desqualificação do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    responsável
    Detalhes da pessoa associada ao lead.

    Tipo de dados: objeto

    "owner": {
  "name": "String",
  "sys_id": "String"
}
    owner.name Nome da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres
    proprietário.sys_id Sys_id do registro de usuário da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    motivo Motivo para a desqualificação do lead, como Desqualificar.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40 caracteres
    short_description Descrição resumida do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    lead_semelhante
    Detalhes sobre qualquer lead semelhante. Use isso para possível desqualificação de lead.

    Tipo de dados: objeto

    "similar_lead": {
  "name": "String",
  "sys_id": "String"
}
    lead_semelhante.nome Nome do lead duplicado.

    Tipo de dados: cadeia de caracteres
    lead_semelhante.sys_id Sys_id do registro de lead que é um possível lead duplicado.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    fase
    Fase do lead, como 100_new.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo de fase da tabela Leads.

    Tipo de dados: cadeia de caracteres
    estado Estado em que o lead reside.

    Tipo de dados: cadeia de caracteres
    rua Rua em que o lead reside.

    Tipo de dados: cadeia de caracteres
    sys_class_name Nome da classe de lead gerado pelo sistema.

    Tipo de dados: cadeia de caracteres
    sys_created_by Nome de usuário da pessoa que criou o lead.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora geradas pelo sistema em que o lead foi criado.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    sys_created_on.​display_value Data e hora em que o lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    sys_created_on.​valor Data e hora em que o lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    sys_domain Sys_id do registro de domínio ao qual o lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    sys_domain_path Caminho do domínio ao qual o lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do registro de lead.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    sys_mod_count Número de vezes que o registro de lead associado foi modificado.

    Tipo de dados: número (inteiro)
    sys_tags Lista de marcadores do sistema associados ao lead. Você pode usar esses marcadores para categorizar leads.

    Tipo de dados: matriz
    sys_updated_by Nome de usuário da pessoa que atualizou o registro de lead pela última vez.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora geradas pelo sistema em que o lead foi atualizado pela última vez.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    sys_updated_on.​display_value Data e hora em que o lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: formato e fuso horário padrão da instância
    sys_updated_on.​valor Data e hora em que o lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    título Título do lead.

    Tipo de dados: cadeia de caracteres
    site URL do site do lead.

    Tipo de dados: cadeia de caracteres
    notas_de_trabalho
    Lista de anotações de trabalho criadas para o lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "author": "String",
    "date": "String",
    "text": "String"
  }
]
    work_notes.​autor Nome de usuário da pessoa que criou a anotação de trabalho associada.

    Tipo de dados: cadeia de caracteres
    work_notes.​data Data em que a anotação foi criada.

    Tipo de dados: cadeia de caracteres
    work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    zip CEP do lead associado.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como atualizar o registro de lead com o sys_id 856b6a95ffde8210b85dffffffffffd7.

    curl " https://instance.service-now.com/api/sn_lead_mgmt_core/v1/lead/856b6a95ffde8210b85dffffffffffd7" \ 
--request PATCH \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data " {
  "lead_source": "inbount_web",
  "business_phone": "+1 (555) 123-4567",
  "do_not_share": true,
  "lead_score": 40,
  "stage": "300_nurturning",
  "do_not_email": false,
  "lead_type": "new_business",
  "work_notes": [
    {
      "text": "Work notes for lead"
    }
  ],
  "lead_rating": "200_warm",
  "lead_line_items": [
    {
      "sys_id" : "013daa19ffde8210b85dffffffffff82",
      "quantity": 10
    },
    {
      "product_offering": {
        "sys_id": "0b61dd9fd0a63110f8770dbf976be171"
      }
    }
  ]
}"

    A resposta contém todos os campos de registro de lead.

    { 
  "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
  "reason": null,
  "country": "USA",
  "closed_date": null,
  "city": "San Francisco",
  "lead_source": "inbount_web",
  "external_id": null,
  "industry": "manufacturing",
  "sys_updated_on": {
    "value": "2024-12-11 08:45:52",
    "display_value": "2024-12-11 00:45:52"
  },
  "title": "Director of Building operations",
  "sys_class_name": "Lead",
  "number": "LEAD0000001",
  "sys_id": "856b6a95ffde8210b85dffffffffffd7",
  "business_phone": "+1 (555) 123-4567",
  "similar_lead": null,
  "sys_updated_by": "abel.tuter",
  "mobile_phone": null,
  "street": "789, Industrial drive",
  "sys_created_on": {
    "value": "2024-05-20 10:32:41",
    "display_value": "2024-05-20 03:32:41"
  },
  "contact": null,
  "company": "Lee Manufacturing Inc",
  "state": "CA",
  "first_name": "James",
  "email": "james.wilson@email.com",
  "consumer": null,
  "sys_created_by": "abel.tuter",
  "zip": "94016",
  "owner": {
    "sys_id": "60058fe943fe3110d6c6cd60afb8f203",
    "name": "Max Blaze"
  },
  "website": null,
  "lead_group": null,
  "sys_mod_count": 4,
  "last_name": "Wilson",
  "other_reason": null,
  "middle_name": null,
  "sys_tags": null,
  "do_not_share": true,
  "lead_score": 40,
  "stage": "300_nurturing",
  "do_not_email": false,
  "lead_type": "new_business",
  "work_notes": [
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:45:52",
      "text": "Lead Line Item [code]<a href='/sn_lead_mgmt_core_lead_line_item.do?sys_id=013daa19ffde8210b85dffffffffff82'>LEADL0000003</a>[/code] has been updated  [code] <b> Quantity </b> [/code] 10 [code] <i>was</i> [/code] 6"
    },
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:45:52",
      "text": "Lead Line Item [code]<a href='/sn_lead_mgmt_core_lead_line_item.do?sys_id=37610e1780925210f877983fa0be6725'>LEADL0001002</a>[/code] has been created  [code] <b> Product Offering </b> [/code] Solana Modem M Series [code] <b> Quantity </b> [/code] 1"
    },
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:45:51",
      "text": "Work notes for lead"
    }
  ],
  "do_not_call": false,
  "lead_rating": "200_warm",
  "account": null,
  "external_system": null,
  "lead_line_items": [
    {
      "quantity": 10,
      "product_offering": {
        "sys_id": "32619d9fd0a63110f8770dbf976be1f9",
        "name": "Safety Test Coverage",
        "code": "SAFETSTCVG1"
      },
      "sys_mod_count": 1,
      "external_id": null,
      "sys_updated_on": {
        "value": "2024-12-11 08:45:52",
        "display_value": "2024-12-11 00:45:52"
      },
      "sys_tags": null,
      "lead": {
        "sys_id": "856b6a95ffde8210b85dffffffffffd7",
        "name": "LEAD0000001"
      },
      "number": "LEADL0000003",
      "sys_id": "013daa19ffde8210b85dffffffffff82",
      "unit_of_measurement": {
        "sys_id": "cb2795d553020110286eddeeff7b12ff",
        "name": "Each"
      },
      "sys_updated_by": "abel.tuter",
      "sys_created_on": {
        "value": "2024-05-20 10:38:41",
        "display_value": "2024-05-20 03:38:41"
      },
      "work_notes": null,
      "sys_created_by": "abel.tuter",
      "external_system": null
    },
    {
      "quantity": 1,
      "product_offering": {
        "sys_id": "0b61dd9fd0a63110f8770dbf976be171",
        "name": "Solana Modem M Series",
        "code": "SOLANAMODE2"
      },
      "sys_mod_count": 0,
      "external_id": null,
      "sys_updated_on": {
        "value": "2024-12-11 08:45:52",
        "display_value": "2024-12-11 00:45:52"
      },
      "sys_tags": null,
      "lead": {
        "sys_id": "856b6a95ffde8210b85dffffffffffd7",
        "name": "LEAD0000001"
      },
      "number": "LEADL0001002",
      "sys_id": "37610e1780925210f877983fa0be6725",
      "unit_of_measurement": null,
      "sys_updated_by": "abel.tuter",
      "sys_created_on": {
        "value": "2024-12-11 08:45:52",
        "display_value": "2024-12-11 00:45:52"
      },
      "work_notes": null,
      "sys_created_by": "abel.tuter",
      "external_system": null
    }
  ]
}

    lead – POST /sn_lead_mgmt_core/lead

    Cria um registro de lead e seus itens de linha de lead associados usando os parâmetros especificados.

    Depois de processados, os registros são criados nas seguintes tabelas:
    • Lead [sn_lead_mgmt_core_lead]
    • Item de linha de lead [sn_lead_mgmt_core_lead_line_item]
    Regras para parâmetros passados:
    • Nomes de parâmetro inválidos são ignorados.
    • Valores inválidos para opções não obrigatórias e campos de referência são ignorados.
    • Se o acesso ao campo WRITE for negado para um ou mais campos, os campos restritos serão ignorados.
    • Você não pode inserir valores de campo do sistema usando esta API. Todos os valores fornecidos são ignorados. Os campos do sistema fazem parte da lista de campos ignorados, que é configurável.
    • Os valores dos parâmetros account, contacte consumer serão ignorados se os parâmetros account e consumer não estiverem vazios.
    • A menos que seja especificado de outra forma, o valor padrão para todos os parâmetros não aprovados é "nulo".

    Formato da URL

    URL com controle de versão: /api/sn_lead_mgmt_core/{api_version}/lead

    URL padrão: /api/sn_lead_mgmt_core/{api_version}/lead

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Parâmetros do corpo da solicitação
    Nome Descrição
    conta Detalhes sobre a conta associada ao lead.
    Tipo de dados: objeto
    "account": {
  "sys_id": "String"
}
    conta.sys_id
    Sys_id do registro de conta associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    business_phone Número de telefone comercial do lead.

    Tipo de dados: cadeia de caracteres
    cidade Cidade na qual o lead reside.

    Tipo de dados: cadeia de caracteres
    empresa Nome da empresa do lead.

    Tipo de dados: cadeia de caracteres
    cliente Consumidor associado ao lead.

    Tipo de dados: objeto

    "consumer": { 
  "sys_id": "String" 
}
    consumidor.sys_id
    Sys_id do registro do consumidor associado.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    contato Contato associado à conta principal.

    Tipo de dados: objeto

    "contact": { 
  "sys_id": "String" 
}
    contato.sys_id
    Sys_id do registro de contato associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    país País no qual o lead reside.

    Tipo de dados: cadeia de caracteres
    do_not_call
    Sinalizador que indica se o modo de comunicação é por telefone.
    Valores válidos:
    • verdadeiro: pode chamar o contato.
    • falso: não ligar para o contato.

    Tipo de dados: booliano

    Padrão: falso
    do_not_email
    Sinalizador que indica se o modo de comunicação é por e-mail.
    Valores válidos:
    • verdadeiro: pode enviar e-mail para contato.
    • falso: não envie e-mail para o contato.

    Tipo de dados: booliano

    Padrão: falso
    não_compartilhar
    Sinalizador que indica se os detalhes do lead podem ser compartilhados.
    Valores válidos:
    • verdadeiro: os detalhes do lead podem ser compartilhados.
    • falso: os detalhes do lead não podem ser compartilhados.

    Tipo de dados: booliano

    Padrão: falso
    e-mail Endereço de e-mail do lead.

    Tipo de dados: cadeia de caracteres
    external_id ID usada pelo sistema que gerou o lead para identificar o lead no sistema associado.

    Tipo de dados: cadeia de caracteres
    sistema_externo Nome do sistema externo associado ao lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    first_name Nome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    setor Setor ao qual o lead pertence.

    Tipo de dados: cadeia de caracteres

    Tabela: localizada no campo industry da tabela Conta [customer_account].

    last_name Obrigatório.
    Sobrenome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    lead_group
    Grupo ao qual o lead pertence.

    Tipo de dados: objeto

    "lead_group": {
  "sys_id": "String"
}
    lead_group.sys_id Sys_id do registro do grupo de leads.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    lead_line_items Lista de itens de linha de lead a serem associados ao lead.
    Grupo ao qual o lead pertence.

    Tipo de dados: objeto

    "lead_line_items": [ 
  { 
    "external_id": "String",
    "external_system": "String",
    "product_offering": {Object},
    "quantity": Number, 
    "work_notes": [Array],
    "unit_of_measurement": {Object} 
  } 
]

    Máximo de itens de linha: 100 - qualquer item a mais será ignorado
    lead_line_items.​external_id ID usada pelo sistema que gerou o item de linha principal para identificar o item de linha no sistema associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​external_system Nome do sistema externo associado ao item de linha de lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    lead_line_items.product_offering Obrigatório. Informações sobre a oferta de produto associada ao item de linha lead.

    Tipo de dados: objeto

    "product_offering": {
  "sys_id": "String"
}
    lead_line_items.product_offering.sys_id Obrigatório.
    Sys_id do registro de oferta de produto associado ao item de linha lead.

    Tipo de dados: cadeia de caracteres

    Tabela: oferta de produto [sn_prd_pm_product_offering]
    lead_line_items.quantidade
    Quantidade de itens que o lead deseja comprar da oferta de produto associada.

    Tipo de dados: número (inteiro)

    Padrão: 1
    lead_line_items.unit_of_measurement
    Detalhes da unidade de medida do item de linha de lead.

    Tipo de dados: objeto

    "unit_of_measurement": {
  "sys_id": "String"
}
    lead_line_items.​unit_of_measurement.​sys_id Sys_id do registro que descreve a unidade de medida.

    Tipo de dados: cadeia de caracteres

    Tabela: unidade de medida [sn_prd_pm_uom]
    lead_line_items.work_notes
    Lista que descreve as anotações de trabalho criadas para o item de linha de lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
    "text": "String"
  }
]
    Padrão: matriz vazia
    lead_line_items.​work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    lead_rating Classificação do lead, como 100_cold, 200_warm, 300_Hot ou 400_Super_Hot.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_rating da tabela Leads.

    Tipo de dados: cadeia de caracteres
    pontuação_lead Pontuação para o lead.

    Tipo de dados: decimal

    Intervalo: 1 a 100
    lead_source Originador do lead.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_source da tabela Leads.

    Tipo de dados: cadeia de caracteres
    lead_type
    Tipo de lead, como Novo negócio ou Negócio existente.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_type da tabela Leads.

    Tipo de dados: cadeia de caracteres
    middle_name Nome do meio do contato para o lead.

    Tipo de dados: cadeia de caracteres
    mobile_phone Número de telefone do contato do lead.

    Tipo de dados: cadeia de caracteres
    outro_razão Motivo adicional para a desqualificação do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    responsável
    Detalhes da pessoa associada ao lead.

    Tipo de dados: objeto

    "owner": {
  "sys_id": "String"
}
    proprietário.sys_id Sys_id do registro de usuário da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    motivo Motivo para a desqualificação do lead, como Desqualificar.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40 caracteres
    short_description Descrição resumida do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    lead_semelhante
    Detalhes sobre qualquer lead semelhante. Use isso para possível desqualificação de lead.

    Tipo de dados: objeto

    "similar_lead": {
  "sys_id": "String"
}
    lead_semelhante.sys_id Sys_id do registro de lead que é um possível lead duplicado.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    fase
    Fase do lead, como 100_new.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo de fase da tabela Leads.

    Tipo de dados: cadeia de caracteres

    Padrão: 100_new
    estado Estado em que o lead reside.

    Tipo de dados: cadeia de caracteres
    rua Rua em que o lead reside.

    Tipo de dados: cadeia de caracteres
    título Título do lead.

    Tipo de dados: cadeia de caracteres
    site URL do site do lead.

    Tipo de dados: cadeia de caracteres
    notas_de_trabalho
    Lista de anotações de trabalho criadas para o lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "text": "String"
  }
]
    Nota:
    Uma matriz de anotações de trabalho na solicitação é inserida como um único texto. Este texto é gerado pela combinação do conteúdo de todos os objetos de anotação de trabalho na solicitação, com cada entrada separada por uma vírgula (,).

    Padrão: matriz vazia
    work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    zip CEP do lead associado.

    Tipo de dados: cadeia de caracteres

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 24. Códigos de status
    Código do status Descrição
    201 Bem-sucedido. O lead e seus itens de linha associados foram inseridos com sucesso.
    400 Erro. Possíveis motivos:
    • Carga inválida: corpo da solicitação inválido/vazio.
    • Carga inválida: valor de campo inválido para campos de e-mail/número de telefone.
    • Carga inválida: o campo obrigatório está ausente ou seu valor está vazio.
    • Violação de regra de negócio/política de dados.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    conta Conta vinculada ao lead.
    Tipo de dados: objeto
    "account": { 
  "name": "String",
  "sys_id": "String"
}
    conta.nome Nome da conta.

    Tipo de dados: cadeia de caracteres
    conta.sys_id
    Sys_id do registro de conta associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    business_phone Número de telefone comercial do lead.

    Tipo de dados: cadeia de caracteres
    cidade Cidade na qual o lead reside.

    Tipo de dados: cadeia de caracteres
    data_fechada Data e hora em que o lead foi encerrado.
    Tipo de dados: objeto
    "closed_date": {
  "display_value": "String", 
  "value": "String"
}
    closed_date.​display_value Data e hora exibidas na IU.

    Tipo de dados: cadeia de caracteres

    Formato: formato e fuso horário do usuário.
    closed_date.value Data e hora em que o lead foi encerrado conforme definido no registro associado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    empresa Nome da empresa do lead.

    Tipo de dados: cadeia de caracteres
    cliente Consumidor associado ao lead.

    Tipo de dados: objeto

    "consumer": {
  "name": "String",
  "sys_id": "String"
}
    consumer.name Nome do consumidor associado.

    Tipo de dados: cadeia de caracteres
    consumidor.sys_id
    Sys_id do registro do consumidor associado.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    contato Contato associado à conta principal.

    Tipo de dados: objeto

    "contact": {
  "name": "String",
  "sys_id": "String" 
}
    contato.nome Nome do contato.

    Tipo de dados: cadeia de caracteres
    contato.sys_id
    Sys_id do registro de contato associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    país País no qual o lead reside.

    Tipo de dados: cadeia de caracteres
    do_not_call
    Sinalizador que indica se o modo de comunicação é por telefone.
    Valores válidos:
    • verdadeiro: pode chamar o contato.
    • falso: não ligar para o contato.

    Tipo de dados: booliano
    do_not_email
    Sinalizador que indica se o modo de comunicação é por e-mail.
    Valores válidos:
    • verdadeiro: pode enviar e-mail para contato.
    • falso: não envie e-mail para o contato.

    Tipo de dados: booliano
    não_compartilhar
    Sinalizador que indica se os detalhes do lead podem ser compartilhados.
    Valores válidos:
    • verdadeiro: os detalhes do lead podem ser compartilhados.
    • falso: os detalhes do lead não podem ser compartilhados.

    Tipo de dados: booliano
    e-mail Endereço de e-mail do lead.

    Tipo de dados: cadeia de caracteres
    external_id ID usada pelo sistema que gerou o lead para identificar o lead no sistema associado.

    Tipo de dados: cadeia de caracteres
    sistema_externo Nome do sistema externo associado ao lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    first_name Nome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    setor Setor ao qual o lead pertence.

    Tipo de dados: cadeia de caracteres

    Tabela: localizada no campo industry da tabela Conta [customer_account].

    last_name
    Sobrenome do contato associado ao lead.

    Tipo de dados: cadeia de caracteres
    lead_group
    Grupo ao qual o lead pertence.

    Tipo de dados: objeto

    "lead_group": {
  "name: "String",
  "sys_id": "String"
}
    lead_group.name Nome do grupo de leads.

    Tipo de dados: cadeia de caracteres
    lead_group.sys_id Sys_id do registro do grupo de leads.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    lead_line_items Detalhes dos itens de linha de lead associados ao lead.

    Tipo de dados: matriz de objetos

    "lead_line_items": [ 
  { 
    "external_id": "String", 
    "external_system": "String",
    "lead": {Object},
    "number": "String",
    "product_offering": {Object},
    "quantity": Number,
    "sys_created_by”: "String",
    "sys_created_on {Object},
    "sys_domain": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "sys_mod_count": Number,
    "sys_tags": [Array],
    "sys_updated_by: "String",
    "sys_updated_on: {Object},
    "unit_of_measurement": {Object}, 
    "work_notes": [Array]
  } 
]
    lead_line_items.​external_id ID usada pelo sistema que gerou o item de linha principal para identificar o item de linha no sistema associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​external_system Nome do sistema externo associado ao item de linha de lead, como HubSpot ou pipedrive.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​lead Detalhes sobre o lead associado ao item de linha.
    Tipo de dados: objeto
    "lead: {
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​lead.name Nome do lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​lead.sys_id Sys_id do registro de lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​number Número exclusivo gerado pelo sistema do registro do item de linha principal.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering Informações sobre a oferta de produto associada ao item de linha lead.

    Tipo de dados: objeto

    "product_offering": {
  "code": " String",
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​product_offering.code Código vinculado à oferta de produto.
    Nota:
    Este é um número alfanumérico gerado pelo sistema com base no nome do produto. Embora seja gerado pelo sistema, você pode editar o código para representar um SKU ou qualquer outro código de produto específico do setor.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering.name Nome da oferta do produto.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​product_offering.sys_id
    Sys_id do registro de oferta de produto associado ao item de linha lead.

    Tipo de dados: cadeia de caracteres

    Tabela: oferta de produto [sn_prd_pm_product_offering]
    lead_line_items.​quantidade
    Quantidade de itens que o lead deseja comprar da oferta de produto associada.

    Tipo de dados: número (inteiro)
    lead_line_items.​sys_created_by Nome de usuário da pessoa que criou o item de linha de lead.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_created_on Data e hora geradas pelo sistema em que o item de linha de lead foi criado.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    lead_line_items.​sys_created_on.display_value Data e hora em que o item de linha de lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    lead_line_items.​sys_created_on.value Data e hora em que o item de linha de lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    lead_line_items.​sys_domain Sys_id do registro de domínio ao qual o item de linha de lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.sys_domain_path Caminho do domínio ao qual o item de linha principal pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_id Sys_id do registro do item de linha principal.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_mod_count Número de vezes que o registro do item de linha de lead associado foi modificado.

    Tipo de dados: número (inteiro)
    lead_line_items.​sys_tags Lista de marcadores do sistema associados ao item de linha de lead.

    Tipo de dados: matriz
    lead_line_items.​sys_updated_by Nome de usuário da pessoa que atualizou pela última vez o item de linha de lead associado.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​sys_updated_on Data e hora geradas pelo sistema em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    lead_line_items.​sys_updated_on.​display_value Data e hora em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    lead_line_items.​sys_updated_on.​value Data e hora em que o item de linha de lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    lead_line_items.​unit_of_measurement
    Detalhes da unidade de medida do item de linha de lead.

    Tipo de dados: objeto

    "unit_of_measurement": {
  "name": "String",
  "sys_id": "String"
}
    lead_line_items.​unit_of_measurement.​name Nome da unidade de medida, como cada ou pé cúbico.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​unit_of_measurement.​sys_id Sys_id do registro que descreve a unidade de medida.

    Tipo de dados: cadeia de caracteres

    Tabela: unidade de medida [sn_prd_pm_uom]
    lead_line_items.​work_notes
    Lista que descreve as anotações de trabalho criadas para o item de linha de lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "author": "String",
    "date": "String",
    "text": "String"
  }
]
    lead_line_items.​work_notes.​autor Nome de usuário da pessoa que criou a anotação de trabalho associada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​work_notes.​date Data em que a anotação foi criada.

    Tipo de dados: cadeia de caracteres
    lead_line_items.​work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    lead_rating Classificação do lead, como 100_cold, 200_warm, 300_Hot ou 400_Super_Hot.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_rating da tabela Leads.

    Tipo de dados: cadeia de caracteres
    pontuação_lead Pontuação para o lead.

    Tipo de dados: decimal

    Intervalo: 1 a 100
    lead_source Originador do lead.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_source da tabela Leads.

    Tipo de dados: cadeia de caracteres
    lead_type
    Tipo de lead, como Novo negócio ou Negócio existente.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo lead_type da tabela Leads.

    Tipo de dados: cadeia de caracteres
    middle_name Nome do meio do contato para o lead.

    Tipo de dados: cadeia de caracteres
    mobile_phone Número de telefone do contato do lead.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo do registro de lead gerado pelo sistema.

    Tipo de dados: cadeia de caracteres
    outro_razão Motivo adicional para a desqualificação do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    responsável
    Detalhes da pessoa associada ao lead.

    Tipo de dados: objeto

    "owner": {
  "name": "String",
  "sys_id": "String"
}
    owner.name Nome da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres
    proprietário.sys_id Sys_id do registro de usuário da pessoa que possui o lead.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    motivo Motivo para a desqualificação do lead, como Desqualificar.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40 caracteres
    short_description Descrição resumida do lead.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160 caracteres
    lead_semelhante
    Detalhes sobre qualquer lead semelhante. Use isso para possível desqualificação de lead.

    Tipo de dados: objeto

    "similar_lead": {
  "name": "String",
  "sys_id": "String"
}
    lead_semelhante.nome Nome do lead duplicado.

    Tipo de dados: cadeia de caracteres
    lead_semelhante.sys_id Sys_id do registro de lead que é um possível lead duplicado.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    fase
    Fase do lead, como 100_new.
    Nota:
    Este é um campo de opção. Ele deve conter um dos itens de opção definidos no campo de fase da tabela Leads.

    Tipo de dados: cadeia de caracteres
    estado Estado em que o lead reside.

    Tipo de dados: cadeia de caracteres
    rua Rua em que o lead reside.

    Tipo de dados: cadeia de caracteres
    sys_class_name Nome da classe de lead gerado pelo sistema.

    Tipo de dados: cadeia de caracteres
    sys_created_by Nome de usuário da pessoa que criou o lead.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora geradas pelo sistema em que o lead foi criado.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    sys_created_on.​display_value Data e hora em que o lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: formato de instância e fuso horário padrão
    sys_created_on.​valor Data e hora em que o lead foi criado.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    sys_domain Sys_id do registro de domínio ao qual o lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    sys_domain_path Caminho do domínio ao qual o lead pertence.
    Nota:
    Este parâmetro só será retornado na resposta se a separação de domínio estiver habilitada.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do registro de lead.

    Tipo de dados: cadeia de caracteres

    Tabela: lead [sn_lead_mgmt_core_lead]
    sys_mod_count Número de vezes que o registro de lead associado foi modificado.

    Tipo de dados: número (inteiro)
    sys_tags Lista de marcadores do sistema associados ao lead. Você pode usar esses marcadores para categorizar leads.

    Tipo de dados: matriz
    sys_updated_by Nome de usuário da pessoa que atualizou o registro de lead pela última vez.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora geradas pelo sistema em que o lead foi atualizado pela última vez.

    Tipo de dados: objeto

    "sys_created_on": {
  "display_value": "String",
  "value": "String"
}
    sys_updated_on.​display_value Data e hora em que o lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: formato e fuso horário padrão da instância
    sys_updated_on.​valor Data e hora em que o lead foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Formato: UTC
    título Título do lead.

    Tipo de dados: cadeia de caracteres
    site URL do site do lead.

    Tipo de dados: cadeia de caracteres
    notas_de_trabalho
    Lista de anotações de trabalho criadas para o lead.

    Tipo de dados: matriz de objetos

    "work_notes": [
  {
    "author": "String",
    "date": "String",
    "text": "String"
  }
]
    work_notes.​autor Nome de usuário da pessoa que criou a anotação de trabalho associada.

    Tipo de dados: cadeia de caracteres
    work_notes.​data Data em que a anotação foi criada.

    Tipo de dados: cadeia de caracteres
    work_notes.​text Texto da anotação feita pelo autor.

    Tipo de dados: cadeia de caracteres
    zip CEP do lead associado.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como criar um novo registro de lead com um item de linha de lead.

    curl " https://instance.service-now.com/api/sn_lead_mgmt_core/v1/lead" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data " {
    "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
    "country": "USA",
    "city": "San Francisco",
    "lead_source": "inbound_phone",
    "industry": "manufacturing",
    "title": "Director of Building operations",
    "business_phone": "+1 (555) 123-4567",
    "street": "789, Industrial drive",
    "company": "Lee Manufacturing Inc",
    "state": "CA",
    "first_name": "James",
    "email": "james.wilson@email.com",
    "consumer": {
      "sys_id": "46ce64ef99ca5210f8779c3cc41bb03c"
    },
    "zip": "94016",
    "website": "example.com",
    "last_name": "Wilson",
    "middle_name": null,
    "do_not_share": false,
    "lead_score": 92,
    "stage": "100_new",
    "do_not_email": false,
    "lead_type": "existing_business",
    "work_notes": [
      {
        "text": "Work notes for lead"
      }
    ],
    "do_not_call": true,
    "lead_rating": "200_warm",
    "lead_line_items": [
      {
        "quantity": 1,
        "product_offering": {
          "sys_id": "32619d9fd0a63110f8770dbf976be1f9"
        },
        "unit_of_measurement": { 
          "sys_id": "cb2795d553020110286eddeeff7b12ff"
        }
      }
  ]
}

    A resposta contém os campos nos registros de lead e itens de linha de lead.

    {
  "short_description": "Looking for a quote on preventative maintenance plans for their corporate office building elevators.",
  "reason": null,
  "country": "USA",
  "closed_date": null,
  "city": "San Francisco",
  "lead_source": "inbound_phone",
  "external_id": null,
  "industry": "manufacturing",
  "sys_updated_on": {
    "value": "2024-12-11 08:35:26",
    "display_value": "2024-12-11 00:35:26"
  },
  "title": "Director of Building operations",
  "sys_class_name": "Lead",
  "number": "LEAD0001001",
  "sys_id": "030f795380925210f877983fa0be67c0",
  "business_phone": "+1 (555) 123-4567",
  "similar_lead": null,
  "sys_updated_by": "abel.tuter",
  "mobile_phone": null,
  "street": "789, Industrial drive",
  "sys_created_on": {
    "value": "2024-12-11 08:35:26",
    "display_value": "2024-12-11 00:35:26"
  },
  "contact": null,
  "company": "Lee Manufacturing Inc",
  "state": "CA",
  "first_name": "James",
  "email": "james.wilson@email.com",
  "consumer": {
    "sys_id": "46ce64ef99ca5210f8779c3cc41bb03c",
    "name": "test"
  },
  "sys_created_by": "abel.tuter",
  "zip": "94016",
  "owner": {
    "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
    "name": "Abel Tuter"
  },
  "website": "example.com",
  "lead_group": null,
  "sys_mod_count": 1,
  "last_name": "Wilson",
  "other_reason": null,
  "middle_name": null,
  "sys_tags": null,
  "do_not_share": false,
  "lead_score": 92,
  "stage": "100_new",
  "do_not_email": false,
  "lead_type": "existing_business",
  "work_notes": [
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:35:26",
      "text": "Work notes for lead"
    },
    {
      "author": "Abel Tuter",
      "date": "2024-12-11 00:35:26",
      "text": "Lead Line Item [code]<a href='/sn_lead_mgmt_core_lead_line_item.do?sys_id=830f795380925210f877983fa0be67c5'>LEADL0001001</a>[/code] has been created  [code] <b> Product Offering </b> [/code] Safety Test Coverage [code] <b> Quantity </b> [/code] 1 [code] <b> Unit of Measure </b> [/code] Each"
    }
  ],
  "do_not_call": true,
  "lead_rating": "200_warm",
  "account": null,
  "external_system": null,
  "lead_line_items": [
    {
      "quantity": 1,
      "product_offering": {
        "sys_id": "32619d9fd0a63110f8770dbf976be1f9",
        "name": "Safety Test Coverage",
        "code": "SAFETSTCVG1"
      },
      "sys_mod_count": 0,
      "external_id": null,
      "sys_updated_on": {
        "value": "2024-12-11 08:35:26",
        "display_value": "2024-12-11 00:35:26"
      },
      "sys_tags": null,
      "lead": {
        "sys_id": "030f795380925210f877983fa0be67c0",
        "name": "LEAD0001001"
      },
      "number": "LEADL0001001",
      "sys_id": "830f795380925210f877983fa0be67c5",
      "unit_of_measurement": {
        "sys_id": "cb2795d553020110286eddeeff7b12ff",
        "name": "Each"
      },
      "sys_updated_by": "abel.tuter",
      "sys_created_on": {
        "value": "2024-12-11 08:35:26",
        "display_value": "2024-12-11 00:35:26"
      },
      "work_notes": null,
      "sys_created_by": "abel.tuter",
      "external_system": null
    }
  ]
}