# Criar ou atualizar um contato com suas informações

Permite criar ou atualizar um contato em uma conversa. A operação executada depende da presença do campo :

- : não envie o campo . Para criar um contato, é obrigatório que o workspace tenha um atributo configurado como chave, e que um valor desse atributo seja previamente criado e incluído na lista de valores de atributos da requisição.
- : envie o campo  com o valor usado na criação para identificar o contato a ser atualizado. Lembrando que o telefone .

Também permite incluir valores personalizados já com seus respectivos atributos — como 'São Paulo (Cidade)', 'Vendas (Departamento)', entre outros — além de possibilitar o envio de um atributo de ativação.

Endpoint: POST /v2/integrations/contact/item/key
Version: 6.0.0
Security: x-api-key

## Request fields (application/json):

  - `key` (string)
    Chave de identificação do contato. Deve conter o valor do atributo configurado como chave no workspace.
- Não deve ser enviado na criação.
- Obrigatório na atualização para localizar o contato.
    Example: "11122233344"

  - `firstname` (string)
    Nome do contato.
    Example: "John"

  - `lastname` (string)
    Sobrenome do contato.
    Example: "Doe"

  - `ddi` (integer)
    DDI do telefone do contato.
    Example: 55

  - `phone` (integer)
    Número de telefone do contato.
    Example: 11912345678

  - `email` (string)
    E-mail do contato.
    Example: "johndoe@email.com"

  - `monesConversationSlug` (string)
    Identificador da conversa onde o contato será criado ou atualizado.
    Example: "00000a000a0000bb0cc0d0000000000"

  - `atributeValueIds` (array)
    Lista de IDs dos valores de atributos personalizados atribuídos ao contato.
- Deve conter obrigatoriamente o valor do atributo configurado como chave (key) no workspace.
- Pode conter valores adicionais.
    Example: [1,2,3]

  - `contactItemActivation` (object)
    Atributo utilizado para ativar o contato ao iniciar a conversa com o BOT.

  - `contactItemActivation.attributeId` (integer)
    Identificador do atributo de contato.
    Example: 1

## Response 200 fields (application/json):

  - `id` (integer)
    Example: 1

  - `firstname` (string)
    Example: "John"

  - `lastname` (string)
    Example: "Doe"

  - `ddi` (integer)
    Example: 55

  - `phone` (integer)
    Example: 5511912345678

  - `email` (string)
    Example: "johndoe@email.com"

  - `cbrEditors` (array,null)
    Example: ["valor 1","valor 2"]

  - `note` (string,null)
    Example: "Este contato possui notas"

  - `slug` (string)
    Example: "00000a000a0000bb0cc0d0000000000"

  - `contactItemGroupValue` (array)

  - `contactItemGroupValue.contactGroupValue` (object)

  - `contactItemGroupValue.contactGroupValue.groupValue` (string)
    Example: "Marketing"

  - `contactItemGroupValue.contactGroupValue.description` (string)
    Example: "Setor responsável por estratégias de promoção, comunicação e posicionamento no mercado."

  - `contactItemGroupValue.contactGroupValue.contactGroup` (object)

  - `contactItemGroupValue.contactGroupValue.contactGroup.name` (string)
    Example: "Setor"

  - `contactItemGroupValue.contactItem` (object)

  - `confirmOptinResponse` (array)

  - `confirmOptinResponse.monesConversation` (object)

  - `confirmOptinResponse.monesConversation.dateStart` (string)
    Example: "2000-01-01T00:00:00Z"

  - `confirmOptinResponse.monesConversation.dateEnd` (string)
    Example: "2000-01-01T00:00:00Z"

  - `confirmOptinResponse.monesConversation.systemTimezone` (object)

  - `confirmOptinResponse.monesConversation.systemTimezone.label` (string)
    Example: "labels.timezone.america.saoPaulo"

  - `confirmOptinResponse.monesConversation.systemTimezone.timezone` (string)
    Example: "America/Sao_Paulo"

  - `confirmOptinResponse.monesConversation.dialog` (object)

  - `confirmOptinResponse.monesConversation.dialog.status` (integer)
    Example: 1

  - `confirmOptinResponse.monesConversation.dialog.systemLocale` (object)

  - `confirmOptinResponse.monesConversation.dialog.systemLocale.lang` (string)
    Example: "pt-BR"

  - `confirmOptinResponse.monesConversation.dialog.cognitionService` (object)

  - `confirmOptinResponse.monesConversation.dialog.dialogEnthusiasm` (object)

  - `confirmOptinResponse.monesConversation.dialog.dialogEnthusiasm.dialogEnthusiasmType` (integer)
    Example: 1

  - `confirmOptinResponse.monesConversation.dialog.watsonDiscovery` (object)

  - `confirmOptinResponse.monesConversation.dialog.queue` (string)
    Example: "queue_example"

  - `confirmOptinResponse.monesConversation.dialog.dialogType` (string)
    Enum: "0", "1"

  - `confirmOptinResponse.monesConversation.dialog.cognitionConversationDialog` (object)

  - `confirmOptinResponse.monesConversation.dialog.cognitionConversationDialog.cognitionConversation` (object)

  - `confirmOptinResponse.monesConversation.dialog.cognitionConversationDialog.cognitionConversation.username` (string)
    Example: "username"

  - `confirmOptinResponse.monesConversation.dialog.cognitionConversationDialog.cognitionConversation.url` (string)
    Example: "https://example.com"

  - `confirmOptinResponse.monesConversation.dialog.cognitionConversationDialog.cognitionConversation.quantity` (integer)
    Example: 1

  - `confirmOptinResponse.monesConversation.contact` (object)

  - `confirmOptinResponse.monesConversation.contact.workspace` (object)

  - `confirmOptinResponse.monesConversation.contact.workspace.passwordExpiration` (integer)
    Example: 1

  - `confirmOptinResponse.monesConversation.contact.workspace.passwordHistory` (integer)
    Example: 1

  - `confirmOptinResponse.monesConversation.contact.workspace.passwordLock` (integer)
    Example: 1

  - `confirmOptinResponse.monesConversation.contact.processImportList` (boolean)

  - `confirmOptinResponse.monesConversation.bot` (object)

  - `confirmOptinResponse.monesConversation.bot.phoneCreated` (string)
    Example: "5511912345678"

  - `confirmOptinResponse.monesConversation.bot.actionProvider` (object)

  - `confirmOptinResponse.monesConversation.bot.actionProvider.hsm` (boolean)

  - `confirmOptinResponse.monesConversation.bot.facebook` (boolean)

  - `confirmOptinResponse.monesConversation.type` (integer)
    Example: 1

  - `confirmOptinResponse.monesConversation.valueOffsetDateStart` (integer)
    Example: -3

  - `confirmOptinResponse.monesConversation.valueOffsetDateEnd` (integer)
    Example: -3

  - `confirmOptinResponse.monesConversation.dateStartTimeZone` (string)
    Example: "2000-01-01T00:00:00.000-03:00"

  - `confirmOptinResponse.monesConversation.dateEndTimeZone` (string)
    Example: "2000-01-01T00:00:00.000-03:00"

  - `confirmOptinResponse.monesConversation.conversationDigit` (boolean)

  - `confirmOptinResponse.monesConversation.urlWebchat` (string)
    Example: "https://exemplo.com"

  - `confirmOptinResponse.monesConversation.preRegister` (boolean)

  - `confirmOptinResponse.monesConversation.voiceType` (string)
    Enum: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18"

  - `confirmOptinResponse.monesConversation.sendTextWhenAudio` (boolean)

  - `confirmOptinResponse.monesConversation.speechToText` (string)
    Enum: "0", "1", "2"

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining` (object)

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.hsmSlug` (string)
    Example: "aa000a00_0000_000b_bb00_00000ccc0000"

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.category` (string)
    Enum: "MARKETING", "UTILITY", "AUTHENTICATION"

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.templateWhatsappParameters` (array)

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.templateWhatsappParameters.templateWhatsapp` (object)

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.templateWhatsappParameters.fileType` (string)
    Example: "TEXT"

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.templateWhatsappParameters.fileParameter` (boolean)

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.templateWhatsappParameters.fileTypeInt` (integer)

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.language` (string)
    Example: "pt-BR"

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.oldCategory` (string)
    Enum: "MARKETING", "UTILITY", "AUTHENTICATION"

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.allowTemplateCategoryChange` (boolean)

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.templateWhatsappButtons` (array)

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.templateWhatsappButtons.parameter` (string)
    Example: "Parâmetro 1"

  - `confirmOptinResponse.monesConversation.templateWhatsappToTraining.hasQuiz` (boolean)

  - `confirmOptinResponse.monesConversation.saveFilesSended` (boolean)

  - `confirmOptinResponse.monesConversation.webhookConversation` (string)
    Example: "webhook-conversation"

  - `confirmOptinResponse.monesConversation.chatgptApiKey` (string)
    Example: "00000a000a0000bb0cc0d0000000000"

  - `confirmOptinResponse.monesConversation.subscriptionId` (string)
    Example: "1"

  - `confirmOptinResponse.monesConversation.voiceInstructions` (string)
    Example: "Exemplo de instruções"

  - `confirmOptinResponse.code` (string)
    Example: "123456"