API do consumidor

Referência de API Zurich

Release

zurich

ft:locale

pt-BR

ft:publication_title

Referência de API Zurich

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

API do consumidor

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

17 min. de leitura

. Consumidor A API fornece endpoints para recuperar e atualizar Customer Service Management (CSM) registros do consumidor.

Além disso, você pode gerar novos registros de perfil de mídia social ao criar um consumidor.

. Consumidor A API requer o plug-in Atendimento ao cliente (com.sn_customerservice) e é fornecida no agora namespace.

Os usuários precisam da função csm_ws_integration para acesso total à API.

Consumidor - OBTER /now/consumer

Recupera um conjunto especificado de Customer Service Management (CSM) registros do consumidor.

Formato de URL

URL com controle de versão: /api/now/api/consumer

URL padrão: /api/now/consumer

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente 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_limit	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use sysparm_offsetparâmetro para paginar a recuperação de registro. Na resposta, o parâmetro booliano hasMoreretornado. Indica se há mais registros a serem retornados que atendem aos critérios de filtro. Tipo de dados: Número Padrão: 10
sysparm_offset	Índice de registro inicial para o qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta 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ê chamar este endpoint, sysparm_offsetdefinido como "0". Para simplesmente percorrer todos os registros disponíveis, use `se você não tiver certeza de que você está usando o sysparm_offset` até chegar ao final de todos os registros. Não passe um número negativo em sysparm_offsetparâmetro. Tipo de dados: Número Padrão: 0
sysparm_query	Consulta codificada usada para filtrar o conjunto de resultados. Por exemplo: `Se você estiver usando o nome de usuário, o nome de usuário será usado para o nome de usuário` A consulta codificada é compatível ordenar por . Para classificar respostas com base em determinados campos, use ORDERBY e. ORDERBYDESC cláusulas em sysparm_query. Por exemplo, `SYsparm_query` 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, como especificar 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: . glide.invalid_query.returns_no_rowsa propriedade 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. Solicitar parâmetros do corpo (XML ou JSON)
Elemento	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
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 5. 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 6. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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 (JSON ou XML)

O endpoint pode retornar os seguintes elementos JSON ou XML no corpo da resposta. Além da lista de elementos definida abaixo (que definem os elementos em um sistema de base), o endpoint também retorna todos os campos personalizados adicionados à tabela Consumidor [csm_consumer]. Para obter informações adicionais sobre esses elementos, consulte a definição de tabela específica [Definição do Sistema > Tabelas].


Elemento	Descrição
ativo	Sinalizador que indica se o consumidor está ativo. Valores possíveis: Verdadeiro: Consumidor ativo Falso: Consumidor desativado Tipo de dados: Booliano Padrão: verdadeiro
business_phone	Número de telefone comercial do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
cidade	Cidade na qual o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
país	País no qual o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
date_format	Formato no qual as datas serão exibidas. Valores válidos: dd-mm-aaaa dd/mm/aaaa dd.mm.aaaa mm-dd-aaaa aaaa-mm-dd Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de data do sistema)
e-mail	Endereço de e-mail do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
fax	Número de fax do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
first_name	Nome do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
sexo	Sexo do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
home_phone	Número de telefone residencial do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
residência	Sys_id do registro que descreve as características da residência. Tipo de dados: Cadeia de caracteres Tabela: Residência [csm_household]
last_name	Sobrenome do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
middle_name	Nome do meio do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
mobile_phone	Número de telefone celular do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
nome	Nome completo do consumidor; first_name, middle_name e last_name. Tipo de dados: Cadeia de caracteres Comprimento máximo: 152
anotações	Anotações sobre o consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 4 000
notificação	Indica se o consumidor deve receber notificações. Valores válidos: 1: Desabilitado 2: Habilitado Tipo de dados: Número (inteiro) Comprimento máximo: 40 Padrão: 2
número	Número exclusivo associado ao consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
foto	Foto do consumidor. Tipo de dados: Imagem
preferred_language	Idioma primário do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
prefixo	Prefixo do nome do consumidor, como Dr., Sr., Sra. Ou Sra Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
primary	Sinalizador que indica se este é o consumidor primário. Valores possíveis: Verdadeiro: Consumidor primário Falso: Não é consumidor primário Tipo de dados: Booliano Padrão: falso
estado	Estado em que o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
rua	Endereço do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
sufixo	Sufixo do nome do consumidor, como Jr., Sr. ou II Tipo de dados: Cadeia de caracteres
sys_created_by	Usuário que criou o registro do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_created_on	Data e hora em que o registro do consumidor foi criado originalmente. Tipo de dados: Cadeia de caracteres
sys_domain	ServiceNow domínio no qual as informações do consumidor residem. Tipo de dados: Cadeia de caracteres
sys_id	Identificador exclusivo do consumidor. Tipo de dados: Cadeia de caracteres
sys_mod_count	Número de vezes que as informações do consumidor associadas foram modificadas. Tipo de dados: Número (inteiro)
sys_tags	Marcadores do sistema. Tipo de dados: Cadeia de caracteres
sys_updated_by	Usuário que atualizou as informações do consumidor pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_updated_on	Data e hora em que as informações do consumidor foram atualizadas pela última vez. Tipo de dados: Cadeia de caracteres
time_format	Formato no qual exibir a hora. Valores válidos: hh.mm.ss a: hh.mm.ss (12 hora) hh:mm:ss a: hh:mm:ss (12 hora) HH.mm.ss: hh.mm.ss (24 hora) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de hora do sistema)
time_zone	Fuso horário do consumidor, como Canadá/Central ou EUA/Leste. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
título	Cargo comercial do consumidor, como gerente, desenvolvedor de software ou prestador de serviço. Tipo de dados: Cadeia de caracteres Comprimento máximo: 60
usuário	Sys_id do usuário consumidor. Tipo de dados: Cadeia de caracteres Tabela: Usuário consumidor [csm_consumer_user]
zip	CEP do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40

Solicitação de curl

curl "https://instance.servicenow.com/api/now/consumer?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "country": "USA",
      "notes": "",
      "gender": "Male",
      "city": "Plano",
      "prefix": "",
      "sys_updated_on": "2016-08-12 00:19:12",
      "suffix": "",
      "title": "",
      "number": "CSMR0000004",
      "notification": "2",
      "sys_id": "01d8403fdb1b1200b6075200cf961941",
      "business_phone": "",
      "sys_updated_by": "prithvi",
      "mobile_phone": "",
      "street": "6900 Dallas Pkwy",
      "sys_created_on": "2016-06-16 19:20:13",
      "sys_domain": "global",
      "state": "TX",
      "fax": "",
      "first_name": "Harding",
      "email": "harding.asher@mailinator.com",
      "preferred_language": "",
      "sys_created_by": "guest",
      "zip": "75024",
      "home_phone": "",
      "time_format": "",
      "sys_mod_count": "8",
      "last_name": "Asher",
      "photo": "",
      "active": "true",
      "middle_name": "",
      "time_zone": "",
      "sys_tags": "",
      "name": "Harding Asher",
      "household": "",
      "date_format": "",
      "user": "c3d35d82c37122005871d44d81d3ae91",
      "primary": "false"
    },
    {
      "country": "USA",
      "notes": "",
      "gender": "Male",
      "city": "San Francisco",
      "prefix": "",
      "sys_updated_on": "2016-08-12 00:20:27",
      "suffix": "",
      "title": "",
      "number": "CSMR0000002",
      "notification": "2",
      "sys_id": "a0488cfbdb1b1200b6075200cf9619db",
      "business_phone": "",
      "sys_updated_by": "prithvi",
      "mobile_phone": "",
      "street": "144 2nd St",
      "sys_created_on": "2016-06-16 19:17:44",
      "sys_domain": "global",
      "state": "CA",
      "fax": "",
      "first_name": "Sam",
      "email": "sam.collins@mailinator.com",
      "preferred_language": "",
      "sys_created_by": "guest",
      "zip": "94105",
      "home_phone": "",
      "time_format": "",
      "sys_mod_count": "13",
      "last_name": "Collins",
      "photo": "",
      "active": "true",
      "middle_name": "",
      "time_zone": "",
      "sys_tags": "",
      "name": "Sam Collins",
      "household": "",
      "date_format": "",
      "user": "64488cfbdb1b1200b6075200cf9619db",
      "primary": "false"
    }
  ]
}

Consumidor - OBTENHA /now/consumer/

Recupera o especificado Customer Service Management (CSM) registro do consumidor.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/consumer/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro do consumidor a ser retornado. Tipo de dados: Cadeia de caracteres Tabela: Consumidor [csm_consumer]

Tabela 8. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

Tabela 10. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 12. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Indica que a solicitação é inválida. Pode ser devido a um dos seguintes motivos: O caso solicitado não existe. O usuário não tem acesso ao registro do consumidor.
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 (JSON ou XML)


Elemento	Descrição
ativo	Sinalizador que indica se o consumidor está ativo. Valores possíveis: Verdadeiro: Consumidor ativo Falso: Consumidor desativado Tipo de dados: Booliano Padrão: verdadeiro
business_phone	Número de telefone comercial do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
cidade	Cidade na qual o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
país	País no qual o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
date_format	Formato no qual as datas serão exibidas. Valores válidos: dd-mm-aaaa dd/mm/aaaa dd.mm.aaaa mm-dd-aaaa aaaa-mm-dd Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de data do sistema)
e-mail	Endereço de e-mail do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
fax	Número de fax do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
first_name	Nome do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
sexo	Sexo do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
home_phone	Número de telefone residencial do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
residência	Sys_id do registro que descreve as características da residência. Tipo de dados: Cadeia de caracteres Tabela: Residência [csm_household]
last_name	Sobrenome do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
middle_name	Nome do meio do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
mobile_phone	Número de telefone celular do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
nome	Nome completo do consumidor; first_name, middle_name e last_name. Tipo de dados: Cadeia de caracteres Comprimento máximo: 152
anotações	Anotações sobre o consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 4 000
notificação	Indica se o consumidor deve receber notificações. Valores válidos: 1: Desabilitado 2: Habilitado Tipo de dados: Número (inteiro) Comprimento máximo: 40 Padrão: 2
número	Número exclusivo associado ao consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
foto	Foto do consumidor. Tipo de dados: Imagem
preferred_language	Idioma primário do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
prefixo	Prefixo do nome do consumidor, como Dr., Sr., Sra. Ou Sra Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
primary	Sinalizador que indica se este é o consumidor primário. Valores possíveis: Verdadeiro: Consumidor primário Falso: Não é consumidor primário Tipo de dados: Booliano Padrão: falso
estado	Estado em que o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
rua	Endereço do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
sufixo	Sufixo do nome do consumidor, como Jr., Sr. ou II Tipo de dados: Cadeia de caracteres
sys_created_by	Usuário que criou o registro do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_created_on	Data e hora em que o registro do consumidor foi criado originalmente. Tipo de dados: Cadeia de caracteres
sys_domain	ServiceNow domínio no qual as informações do consumidor residem. Tipo de dados: Cadeia de caracteres
sys_id	Identificador exclusivo do consumidor. Tipo de dados: Cadeia de caracteres
sys_mod_count	Número de vezes que as informações do consumidor associadas foram modificadas. Tipo de dados: Número (inteiro)
sys_updated_by	Usuário que atualizou as informações do consumidor pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_updated_on	Data e hora em que as informações do consumidor foram atualizadas pela última vez. Tipo de dados: Cadeia de caracteres
time_format	Formato no qual exibir a hora. Valores válidos: hh.mm.ss a: hh.mm.ss (12 hora) hh:mm:ss a: hh:mm:ss (12 hora) HH.mm.ss: hh.mm.ss (24 hora) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de hora do sistema)
time_zone	Fuso horário do consumidor, como Canadá/Central ou EUA/Leste. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
título	Cargo comercial do consumidor, como gerente, desenvolvedor de software ou prestador de serviço. Tipo de dados: Cadeia de caracteres Comprimento máximo: 60
usuário	Sys_id do usuário consumidor. Tipo de dados: Cadeia de caracteres Tabela: Usuário consumidor [csm_consumer_user]
zip	CEP do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40

Solicitação de curl

curl "https://instance.servicenow.com/api/now/consumer/01d8403fdb1b1200b6075200cf961941 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "country": "USA",
    "notes": "",
    "gender": "Male",
    "city": "Plano",
    "prefix": "",
    "sys_updated_on": "2016-08-12 00:19:12",
    "suffix": "",
    "title": "",
    "number": "CSMR0000004",
    "notification": "2",
    "sys_id": "01d8403fdb1b1200b6075200cf961941",
    "business_phone": "",
    "sys_updated_by": "prithvi",
    "mobile_phone": "",
    "street": "6900 Dallas Pkwy",
    "sys_created_on": "2016-06-16 19:20:13",
    "sys_domain": "global",
    "state": "TX",
    "fax": "",
    "first_name": "Harding",
    "email": "harding.asher@mailinator.com",
    "preferred_language": "",
    "sys_created_by": "guest",
    "zip": "75024",
    "home_phone": "",
    "time_format": "",
    "sys_mod_count": "8",
    "last_name": "Asher",
    "photo": "",
    "active": "true",
    "middle_name": "",
    "time_zone": "",
    "sys_tags": "",
    "name": "Harding Asher",
    "household": "",
    "date_format": "",
    "user": "c3d35d82c37122005871d44d81d3ae91",
    "primary": "false"
  }
}

POST/now/consumer - PUBLICAR /consumer

Cria um novo Customer Service Management (CSM) consumidor.

Além disso, você pode criar um perfil de mídia social para o consumidor usando este endpoint. Para criar o perfil, você deve especificar os seguintes parâmetros no corpo da solicitação:

social_channel
social_handle
social_handle_url

Aviso:

Este endpoint não executa a validação de parâmetro, pois isso pode criar sobrecarga excessiva. Se um parâmetro de solicitação estiver incorreto, não for válido ou não for compatível com o endpoint, ele será ignorado sem aviso.

Formato de URL

URL com controle de versão: /api/now/api/consumer

URL padrão: /api/now/consumer

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 14. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
Elemento	Descrição
ativo	Sinalizador que indica se o consumidor está ativo. Valores possíveis: Verdadeiro: Consumidor ativo Falso: Consumidor desativado Tipo de dados: Booliano Padrão: verdadeiro
business_phone	Número de telefone comercial do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
cidade	Cidade na qual o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
país	País no qual o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
date_format	Formato no qual as datas serão exibidas. Valores válidos: dd-mm-aaaa dd/mm/aaaa dd.mm.aaaa mm-dd-aaaa aaaa-mm-dd Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de data do sistema)
e-mail	Endereço de e-mail do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
fax	Número de fax do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
first_name	Nome do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
sexo	Sexo do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
home_phone	Número de telefone residencial do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
residência	Sys_id do registro que descreve as características da residência. Tipo de dados: Cadeia de caracteres Tabela: Residência [csm_household]
last_name	Sobrenome do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
middle_name	Nome do meio do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 50
mobile_phone	Número de telefone celular do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
nome	Nome completo do consumidor; first_name, middle_name e last_name. Tipo de dados: Cadeia de caracteres Comprimento máximo: 152
anotações	Anotações sobre o consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 4 000
notificação	Indica se o consumidor deve receber notificações. Valores válidos: 1: Desabilitado 2: Habilitado Tipo de dados: Número (inteiro) Comprimento máximo: 40 Padrão: 2
foto	Foto do consumidor. Tipo de dados: Imagem
preferred_language	Idioma primário do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
prefixo	Prefixo do nome do consumidor, como Dr., Sr., Sra. Ou Sra Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
primary	Sinalizador que indica se este é o consumidor primário. Valores possíveis: Verdadeiro: Consumidor primário Falso: Não é consumidor primário Tipo de dados: Booliano Padrão: falso
social_channel	Canal de mídia social ao qual o consumidor está associado, como Twitter, Facebook ou Instagram. Tipo de dados: Cadeia de caracteres
social_handle	Identificador do usuário no canal de mídia social. Tipo de dados: Cadeia de caracteres
social_handle_url	URL para o identificador do canal social do consumidor. Tipo de dados: Cadeia de caracteres
estado	Estado em que o consumidor reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 100
rua	Endereço do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
sufixo	Sufixo do nome do consumidor, como Jr., Sr. ou II Tipo de dados: Cadeia de caracteres
time_format	Formato no qual exibir a hora. Valores válidos: hh.mm.ss a: hh.mm.ss (12 hora) hh:mm:ss a: hh:mm:ss (12 hora) HH.mm.ss: hh.mm.ss (24 hora) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de hora do sistema)
time_zone	Fuso horário do consumidor, como Canadá/Central ou EUA/Leste. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
título	Cargo comercial do consumidor, como gerente, desenvolvedor de software ou prestador de serviço. Tipo de dados: Cadeia de caracteres Comprimento máximo: 60
usuário	Sys_id do usuário consumidor. Tipo de dados: Cadeia de caracteres Tabela: Usuário consumidor [csm_consumer_user]
zip	CEP do consumidor. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40

Cabeçalhos

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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status
Código do status	Descrição
201	O novo registro do consumidor foi criado com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
500	Erro Interno do servidor. Ocorreu um erro de lógica no código do lado do servidor.

Parâmetros do corpo da resposta (JSON ou XML)


Elemento	Descrição
resultado	Sys_id do registro do consumidor recém-criado. Tipo de dados: Cadeia de caracteres

Solicitação de curl

curl -X POST "https://instance.servicenow.com/api/now/consumer" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d " { \
  "country": "USA", \
  "notes": "Never comes in before 10am", \
  "gender": "Female", \
  "city": "San Marcos", \
  "prefix": "Ms", \
  "title": "Director", \
  "notification": "1", \
  "business_phone": "(555)555-1234", \
  "mobile_phone": "(555)555-1235", \
  "street": "123 Sesame St", \
  "state": "CA", \
  "fax": "(555)555-1236", \
  "first_name": "Jane", \
  "zip": "92001", \
  "home_phone": "(555)555-1234", \
  "last_name": "Brown", \
  "active": "true", \
  "middle_name": "Dell", \
  "time_zone": "PST", \
  "name": "Jane Brown", \
  "household": "4", \
  "user": "c3d35d82c37122005871d44d81d3ae91", \
  "primary": "false" \
}"
--user "username":"password"

{
    "result": "0f5c13addb93230057c3fd441d9619b8"
}