Conversas

Alterar

Atualiza um ou mais atributos de uma conversa. Para usar você deve informar o novo valor do atribuito e quais atributos serão atualizados.

put/v2/session/{id}/partial

Request

  • Base URL: https://api.helena.run/core
  • URL: https://api.helena.run/core/v2/session/{id}/partial
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

ID da conversa.

Request body

companyIdstring uuid

Código da empresa

status'UNDEFINED' | 'STARTED' | 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'HIDDEN' nullable

Situação do atendmento

endAtstring date-time nullable

Data de conclusão

numberstring nullable

Código de identificação

departmentIdstring uuid nullable

Código da equipe

userIdstring uuid nullable

Código do usuário / atendente

metadataobject nullable

Definição dos metadados

fieldsstring[] nullable

Definição dos campos a serem atualizados

Response

Success

idstring uuid
createdAtstring date-time
updatedAtstring date-time
startAtstring date-time
endAtstring date-time nullable
status'UNDEFINED' | 'STARTED' | 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'HIDDEN'
companyIdstring uuid
contactIdstring uuid nullable
channelIdstring uuid
departmentIdstring uuid nullable
userIdstring uuid nullable
previewUrlstring nullable
titlestring nullable
numberstring nullable
originstring nullable
statusDescriptionstring nullable
timeServicestring nullable
timeWaitstring nullable
firstResponseAtstring date-time nullable
botIdstring uuid nullable
unreadCountinteger
lastMessageTextstring nullable
lastInteractionDatestring date-time nullable
lastMessageOutstring date-time nullable
lastMessageInstring date-time nullable
windowStatus'ACTIVE' | 'EXPIRED' | 'NOT_STARTED'
metadataobject nullable
channelType'GUPSHUP_WHATSAPP' | 'DIALOG360_WHATSAPP' | 'CLOUDAPI_WHATSAPP' | 'ZAPI_WHATSAPP' | 'EVOLUTIONAPI_WHATSAPP' | 'INSTAGRAM' | 'MESSENGER' nullable

Changes

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