Contatos

Atualizar por Número de telefone

put/v1/contact/phonenumber/{phone}

Request

  • Base URL: https://api.helena.run/core
  • URL: https://api.helena.run/core/v1/contact/phonenumber/{phone}
  • Auth: API key in header Authorization

Path parameters

phonestring required

Número de telefone.

Request body

fieldsstring[] nullable

Campos a serem atualizados.

namestring nullable

Nome do contato.

phoneNumberstring nullable

Número no WhatsApp.

emailstring nullable

Endereço de email.

instagramstring nullable

Nome de usuário no Instagram.

annotationstring nullable

Notas internas da equipe.

tagIdsstring[] nullable

IDs das etiquetas atribuídas.

tagNamesstring[] nullable

Nomes das etiquetas atribuídas. Este campo será ignorado caso TagIds seja definido.

portfolioIdsstring[] nullable

IDs das carteiras atribuídas.

portfolioNamesstring[] nullable

Nomes das carteiras atribuídas. Este campo será ignorado caso PortfolioIds seja definido.

sequenceIdsstring[] nullable

IDs das sequências atribuídas.

status'ACTIVE' | 'ARCHIVED' | 'BLOCKED' nullable

Status do contato.

pictureUrlstring nullable

Informe neste campo uma Url para definição da imagem do contato

customFieldsobject 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.

metadataobject 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.

Response

Success

idstring uuid
createdAtstring date-time
updatedAtstring date-time
companyIdstring uuid
namestring nullable
nameWhatsappstring nullable
nameInstagramstring nullable
nameMessengerstring nullable
phoneNumberstring nullable
phoneNumberFormattedstring nullable
emailstring nullable
instagramstring nullable
messengerIdstring nullable
annotationstring nullable
tagIdsstring[] nullable
tagNamesstring[] nullable
status'ACTIVE' | 'ARCHIVED' | 'BLOCKED'
origin'CREATED_BY_USER' | 'CREATED_FROM_HUB' | 'IMPORTED'
importedAtstring date-time nullable
customFieldsobject nullable
portfolioIdsstring[] nullable
portfolioNamesstring[] nullable
metadataobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.