v1

latestOpenAPI 3.0.12026-08-04115177259.2 KB

Cards

Atualizar

put/v3/panel/card/{id}

Path parameters

idstring required

ID do card.

Request body

fieldsstring[] nullable

Campos a serem atualizados.

stepIdstring uuid nullable

ID da etapa do painel para onde o item deverá ser movido.

titlestring nullable

Título do item.

descriptionstring nullable

Descrição do item.

positionnumber double nullable

Posição do item na etapa.

dueDatestring date-time nullable

Data de vencimento do item.

responsibleUserIdstring uuid nullable

ID do usuário responsável pelo item.

tagIdsstring[] nullable

IDss das etiquetas atribuídas.

tagNamesstring[] nullable

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

contactIdsstring[] nullable

IDs dos contatos relacionados ao item.

sessionIdstring uuid nullable

ID da conversa relacionada ao item.

monetaryAmountnumber double nullable

Valor monetário atribuído ao item.

status'OPEN' | 'WON' | 'LOST' | 'ARCHIVED' nullable

Determina o status do item.

lostReasonIdstring uuid nullable

ID do motivo de perda.

customFieldsobject nullable

Objeto chave-valor para definir valores de campos personalizados no item. 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 item. Neste campo, pode ser salvo qualquer propriedade adicional para o item, na estrutura chave-valor.

Para adicionar um metadado: utilize uma chave não utilizada anteriormente neste item, atribuindo o novo valor;
Para atualizar um metadado: utilize a chave salva anteriormente neste item, 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

panelIdstring uuid

panelTitlestring nullable

stepIdstring uuid

stepTitlestring nullable

stepPhase'NONE' | 'INITIAL' | 'FINAL' nullable

positionnumber double