---
title: "Atualizar"
method: PUT
path: "/v2/contact/{id}"
tags: ["Contatos"]
---

# Atualizar

`PUT /v2/contact/{id}`

## Path parameters

- `id` string, uuid, required

## Request body

- PublicReqUpdateContactDTO
  - `fields` string[], nullable — Campos a serem atualizados.
  - `name` string, nullable — Nome do contato.
  - `phoneNumber` string, nullable — Número no WhatsApp.
  - `email` string, nullable — Endereço de email.
  - `instagram` string, nullable — Nome de usuário no Instagram.
  - `annotation` string, nullable — Notas internas da equipe.
  - `tagIds` string[], nullable — IDs das etiquetas atribuídas.
  - `tagNames` string[], nullable — Nomes das etiquetas atribuídas. Este campo será ignorado caso `TagIds` seja definido.
  - `portfolioIds` string[], nullable — IDs das carteiras atribuídas.
  - `portfolioNames` string[], nullable — Nomes das carteiras atribuídas. Este campo será ignorado caso `PortfolioIds` seja definido.
  - `sequenceIds` string[], nullable — IDs das sequências atribuídas.
  - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED', nullable — Status do contato.
  - `pictureUrl` string, nullable — Informe neste campo uma Url para definição da imagem do contato
  - `customFields` object, nullable — Objeto chave-valor para definir valores de campos personalizados no contato. Cada item do objeto deverá ter como nome a chave do campo personalizado. Caso a chave não corresponda a algum campo personalizado ou o tipo de dados do valor seja incompatível, o item será ignorado.
  - `metadata` object, nullable — Metadados relevantes para o contato. Neste campo, pode ser salvo qualquer propriedade adicional para o contato, na estrutura chave-valor. - Para adicionar um metadado: utilize uma chave não utilizada anteriormente neste contato, atribuindo o novo valor; - Para atualizar um metadado: utilize a chave salva anteriormente neste contato, atribuindo o novo valor; - Para remover um metadado: utilize a chave salva anteriormente, atribuindo valor nulo.
  - `utm` PublicUtmDTO
    - `sourceId` string, nullable
    - `source` string, nullable
    - `clid` string, nullable
    - `medium` string, nullable
    - `campaign` string, nullable
    - `content` string, nullable
    - `headline` string, nullable
    - `term` string, nullable
    - `referralUrl` string, nullable
  - `options` PublicReqContactUpdatePartialOptionsDTO
    - `tagsOperation` 'InsertIfNotExists' | 'DeleteIfExists' | 'ReplaceAll' — Define como as listas de tags devem ser tratadas ao atualizar, como padrão será InsertIfNotExists

## Response `200`

Success

- PublicContactDTO
  - `id` string, uuid
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `companyId` string, uuid
  - `name` string, nullable
  - `nameWhatsapp` string, nullable
  - `nameInstagram` string, nullable
  - `nameMessenger` string, nullable
  - `phoneNumber` string, nullable
  - `phoneNumberFormatted` string, nullable
  - `email` string, nullable
  - `instagram` string, nullable
  - `messengerId` string, nullable
  - `annotation` string, nullable
  - `tagIds` string[], nullable
  - `tagNames` string[], nullable
  - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED'
  - `origin` 'CREATED_BY_USER' | 'CREATED_FROM_HUB' | 'IMPORTED'
  - `importedAt` string, date-time, nullable
  - `utm` PublicUtmDTO
    - `sourceId` string, nullable
    - `source` string, nullable
    - `clid` string, nullable
    - `medium` string, nullable
    - `campaign` string, nullable
    - `content` string, nullable
    - `headline` string, nullable
    - `term` string, nullable
    - `referralUrl` string, nullable
  - `customFields` object, nullable
  - `portfolioIds` string[], nullable
  - `portfolioNames` string[], nullable
  - `metadata` object, nullable

## Other responses

- `500` — Server Error

---

[API](https://skmtc.net/helena/apis/core.md) · [All operations](https://skmtc.net/helena/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helena/core/versions/811b2cdd2ec2/schema)