GetAccept
A GetAccept fornece uma plataforma de capacitação de vendas para que as vendas projetem, enviem, promovam, rastreiem e assinem documentos de vendas eletrônicos, aproveitando garantias de vendas, gerenciamento de contratos, propostas e assinaturas eletrônicas em um só lugar.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Equipe da API GetAccept |
| URL | https://app.getaccept.com/api |
| integrations@getaccept.com |
| Metadados do conector | |
|---|---|
| Editora | GetAccept, Inc. |
| Sítio Web | https://www.getaccept.com |
| Política de privacidade | https://www.getaccept.com/privacy-policy |
| Categorias | Vendas e CRM; Produtividade |
A GetAccept fornece uma plataforma de capacitação de vendas para que as vendas projetem, enviem, promovam, rastreiem e assinem documentos de vendas eletrônicos, aproveitando garantias de vendas, gerenciamento de contratos, propostas e assinaturas eletrônicas em um só lugar. Esse conector ajuda a automatizar seus fluxos de trabalho para armazenamento de documentos, recuperação, atribuição de tarefas e notificações personalizadas.
Pré-requisitos
Uma conta GetAccept é necessária para usar essa conexão. Aceda a getaccept.com para registar uma conta gratuita.
Como obter credenciais?
Somente uma conta GetAccept válida é necessária, pois OAuth2 é usado para autenticar o usuário conectado atual em GetAccept.
Problemas conhecidos e limitações
Entre em contato com nosso [mailto:support@getaccept.com](suporte técnico) para quaisquer problemas relacionados à integração.
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar validade do documento |
Use esse método para atualizar a data e a hora de expiração de um documento. |
| Carregar um anexo |
Pode carregar ficheiros anexos para incluir nos documentos que enviar. O pedido bem-sucedido devolverá o attachment_id. Use attachment_id para atribuir um anexo a um documento. |
| Carregar um ficheiro de documento |
Pode carregar um ficheiro de cada vez e obter um ID de ficheiro. A ID do arquivo é usada para conectar um arquivo a um documento GetAccept que é enviado aos destinatários. Se você quiser fazer upload de arquivos mutliple você executa vários POST. Só aceitamos ficheiros até 10 MB como predefinição. O ficheiro carregado tem de ser importado/adicionado a um documento no prazo de 48 horas após o carregamento. Recomendamos que carregue ficheiros PDF para garantir o mesmo aspeto quando enviado. Outros tipos de arquivos podem ser convertidos, como: Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: números, chave Imagens: jpg, jpeg, png Outros: html, tex, csv |
| Carregar um vídeo |
Pode carregar ficheiros anexos para incluir nos documentos que enviar. O pedido bem-sucedido devolverá o attachment_id. Use attachment_id para atribuir um anexo a um documento. |
| Criar contacto |
Isso criará um novo contato no banco de dados para a entidade atual |
| Criar e enviar documento ou modelo |
Você deve criar um documento para poder enviá-lo a um destinatário. Ao criar um documento, você pode consultar arquivos carregados anteriormente com file_id ou pode optar por criar um documento e carregar os arquivos na postagem da API. Você só pode carregar UM arquivo ao incluir um arquivo no documento de criação POST. Use um parâmetro file_ids para usar o(s) arquivo(s) carregado(s) existente(s) file_content para enviar o documento como cadeia de caracteres codificada em base64 ou faça uma postagem com várias partes com o parâmetro file. Todos os destinatários devem ter um e-mail válido ou um número de celular. Todos os eventos são gravados usando o endereço IP do solicitante. Você pode substituir isso usando CLIENT_IP de cabeçalho contendo o endereço IP público dos usuários finais. |
| Criar utilizador |
Isso criará um novo contato no banco de dados para a entidade atual |
| Descarregar documento |
O arquivo de documento sempre pode ser baixado, mas é muito provável que você queira baixá-lo quando ele tiver o status Assinado. Você pode selecionar para receber um download-url ou obter o arquivo binário. O URL de download pode ser acessado 10 minutos após a solicitação ter sido feita. |
| Enviar documento existente |
Quando você envia um documento via GetAccept, entregamos um e-mail a todos os destinatários, cada um contendo um link exclusivo e seguro. Esta chamada de API aciona a ação de envio de documentos e só pode ser executada em documentos com document_status = rascunho. O documento será enviado aos destinatários que forneceu quando foi criado. Se o documento foi criado usando a opção de autoassinatura, ele também será autoassinado pelo usuário autenticado ou especificado antes de enviar. |
| Lista de utilizadores |
Obter uma lista de usuários ativos para a entidade autenticada atual |
| Listar anexos |
Receba uma lista de anexos disponíveis. Você pode adicionar novos anexos em GetAccept usando um novo documento. |
| Listar contatos |
Receba uma lista de contatos disponíveis para a entidade atual. Todos os contatos adicionados como destinatários são salvos como um contato e ficam disponíveis para uso posterior nessa entidade. |
| Listar documentos |
Obter uma lista de documentos disponíveis |
| Listar vídeos |
Receba uma lista de vídeos disponíveis sobre a entidade. Você pode adicionar novos vídeos no aplicativo móvel ou dentro do GetAccept. |
| Modelos de lista |
Receba uma lista de modelos de documentos disponíveis. Você pode adicionar novos modelos na seção Modelos em GetAccept. |
| Obter anexos de documentos |
Obtenha anexos de documentos especificando uma ID de documento. |
| Obter campos de documento |
Obtenha uma lista de campos para um documento ou modelo. Pode ser usado antes e depois da assinatura de um documento. |
| Obter campos de modelo |
Receba uma lista de campos para um modelo específico. |
| Obter destinatários do documento |
Obtenha uma lista de destinatários para um documento específico. |
| Obter detalhes do documento |
Obtenha detalhes do documento especificando uma ID do documento. |
| Obter detalhes do utilizador |
Esta chamada retornará detalhes de um único usuário. Receber detalhes e entidades disponíveis do usuário autenticado atual usando user-id me |
| Obter funções de modelo |
Receba uma lista de funções para um modelo específico. |
| Obter tabelas de preços de modelo |
Receba uma lista de itens da tabela de preços para um modelo específico. |
Atualizar validade do documento
Use esse método para atualizar a data e a hora de expiração de um documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
Data de validade
|
expiration_date | date-time |
Data e hora em que o documento deve expirar (UTC) |
|
|
Enviar notificação
|
send_notification | boolean |
Se uma notificação sobre a atualização for enviada aos destinatários |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | integer |
Estado da atualização |
Carregar um anexo
Pode carregar ficheiros anexos para incluir nos documentos que enviar. O pedido bem-sucedido devolverá o attachment_id. Use attachment_id para atribuir um anexo a um documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do ficheiro
|
file_content | string |
Envie o arquivo como base64 codificado. Observe que os arquivos de codificação base64 aumentarão o tamanho do arquivo com cerca de 30% |
|
|
Nome do ficheiro
|
file_name | string |
Nome do arquivo do documento, com a extensão. Isso será útil para converter diferentes tipos de arquivo. |
|
|
URL do ficheiro
|
file_url | string |
Url para arquivo de documento. O arquivo deve estar disponível para download sem qualquer autorização |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do ficheiro
|
filename | string |
Nome do ficheiro do anexo |
|
ID do anexo
|
id | string |
ID do anexo carregado a ser usado em attachment_id ao criar um documento |
|
Título do anexo
|
title | string |
Título do anexo |
|
Tipo de anexo
|
type | string |
Tipo de anexo |
Carregar um ficheiro de documento
Pode carregar um ficheiro de cada vez e obter um ID de ficheiro. A ID do arquivo é usada para conectar um arquivo a um documento GetAccept que é enviado aos destinatários. Se você quiser fazer upload de arquivos mutliple você executa vários POST. Só aceitamos ficheiros até 10 MB como predefinição. O ficheiro carregado tem de ser importado/adicionado a um documento no prazo de 48 horas após o carregamento.
Recomendamos que carregue ficheiros PDF para garantir o mesmo aspeto quando enviado. Outros tipos de arquivos podem ser convertidos, como:
Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: números, chave Imagens: jpg, jpeg, png Outros: html, tex, csv
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do ficheiro
|
file_content | string |
Envie o arquivo como base64 codificado. Observe que os arquivos de codificação base64 aumentarão o tamanho do arquivo com cerca de 30% |
|
|
Nome do ficheiro
|
file_name | string |
Nome do arquivo do documento, com a extensão. Isso será útil para converter diferentes tipos de arquivo. |
|
|
URL do ficheiro
|
file_url | string |
Url para arquivo de documento. O arquivo deve estar disponível para download sem qualquer autorização |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
identificação_de_ficheiro
|
file_id | string |
ID do ficheiro carregado a utilizar em file_ids ao criar um documento |
|
file_status
|
file_status | string |
Estado do ficheiro carregado |
Carregar um vídeo
Pode carregar ficheiros anexos para incluir nos documentos que enviar. O pedido bem-sucedido devolverá o attachment_id. Use attachment_id para atribuir um anexo a um documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do ficheiro
|
file_content | string |
Envie o arquivo como base64 codificado. Observe que os arquivos de codificação base64 aumentarão o tamanho do arquivo com cerca de 30% |
|
|
Nome do ficheiro
|
file_name | string |
Nome do arquivo do documento, com a extensão. Isso será útil para converter diferentes tipos de arquivo. |
|
|
URL do ficheiro
|
file_url | string |
Url para arquivo de documento. O arquivo deve estar disponível para download sem qualquer autorização |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Estado do ficheiro
|
file_status | string |
Estado do vídeo |
|
Nome do ficheiro
|
filename | string |
Nome do ficheiro do vídeo |
|
ID do trabalho
|
job_id | string |
Id do trabalho de processamento convertendo e compactando o vídeo. Sondagem para atualizações de status do trabalho usando /video/job/<ID>. |
|
ID do vídeo
|
video_id | string |
ID do vídeo carregado a ser usado em video_id ao criar um documento |
Criar contacto
Isso criará um novo contato no banco de dados para a entidade atual
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da Empresa
|
company_name | string |
Nome da empresa associada |
|
|
Número da Empresa
|
company_number | string |
Número da empresa associada |
|
|
Email
|
string |
Endereço de e-mail do contato |
||
|
Nome próprio
|
first_name | string |
Nome próprio do contacto |
|
|
Nome completo
|
fullname | string |
Use para especificar nome completo em vez de nome/sobrenome |
|
|
Apelido
|
last_name | string |
Apelido do contacto |
|
|
Telemóvel
|
mobile | string |
Número de telemóvel em formato internacional |
|
|
Observação
|
note | string |
Nota interna opcional para contacto |
|
|
Telemóvel
|
phone | string |
Número de telefone em formato internacional |
|
|
Title
|
title | string |
O título do contato, ex. CEO, Gerente de vendas |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de contato
|
contact_id | string |
ID do contacto criado |
Criar e enviar documento ou modelo
Você deve criar um documento para poder enviá-lo a um destinatário. Ao criar um documento, você pode consultar arquivos carregados anteriormente com file_id ou pode optar por criar um documento e carregar os arquivos na postagem da API. Você só pode carregar UM arquivo ao incluir um arquivo no documento de criação POST.
Use um parâmetro file_ids para usar o(s) arquivo(s) carregado(s) existente(s) file_content para enviar o documento como cadeia de caracteres codificada em base64 ou faça uma postagem com várias partes com o parâmetro file.
Todos os destinatários devem ter um e-mail válido ou um número de celular.
Todos os eventos são gravados usando o endereço IP do solicitante. Você pode substituir isso usando CLIENT_IP de cabeçalho contendo o endereço IP público dos usuários finais.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
ID do anexo recebido da lista ou após o carregamento |
|
|
Exigir visualização
|
require_view | boolean |
Exigir que o destinatário visualize o anexo |
|
|
Tipo
|
type | string |
ou externo, onde o arquivo é um arquivo carregado e externo é um link para um arquivo externo |
|
|
ID do campo
|
id | string |
ID do campo de modelo personalizado |
|
|
Nome do campo
|
name | string |
Nome do campo de modelo personalizado |
|
|
Valor de Campo
|
value | string |
Valor do campo de modelo personalizado |
|
|
Moeda
|
currency | string |
Moeda, ex. SEK |
|
|
Localidade
|
locale | string |
Localidade, ex. sv-SE |
|
|
Nome de exibição
|
display_name | string |
Nome para exibição da tabela de preços |
|
|
ID externo
|
external_id | string |
ID externo para representar o objeto de resumo dentro de um sistema de terceiros |
|
|
ID da tabela
|
id | string |
ID da tabela |
|
|
Totais pré-calculados
|
pre_calculated | boolean |
Se os totais da tabela de preços devem ser pré-calculados |
|
|
Nome de exibição
|
display_name | string |
Nome para exibição da tabela de preços |
|
|
ID
|
id | string |
ID da secção |
|
|
Rows
|
rows |
Matriz com valores objeto com matriz de column_id, valor |
||
|
Ativado(a)
|
enabled | boolean |
Se o desconto de seção deve ser ativado |
|
|
Taxa fixa
|
flat_fee | boolean |
Se a seção deve usar usando descontos de taxa fixa |
|
|
Valor do desconto
|
value | string |
O valor do desconto da secção |
|
|
Ativado(a)
|
enabled | boolean |
Se o preço da seção deve ser ativado |
|
|
Taxa fixa
|
flat_fee | boolean |
Se a seção deve usar o preço de taxa fixa |
|
|
Valor do preço
|
value | string |
O valor para o preço da seção |
|
|
Ativado(a)
|
enabled | boolean |
Se o imposto de seção deve ser habilitado |
|
|
Taxa fixa
|
flat_fee | boolean |
Se a seção deve usar usando taxas fixas |
|
|
Valor Fiscal
|
value | string |
O valor do imposto de secção |
|
|
Ativado(a)
|
enabled | boolean |
Se o desconto da tabela de preços deve ser ativado |
|
|
Taxa fixa
|
flat_fee | boolean |
Se a tabela de preços deve usar usando descontos de taxa fixa |
|
|
Valor do desconto
|
value | string |
O valor do desconto sumário |
|
|
Ativado(a)
|
enabled | boolean |
Se o preço da tabela de preços deve ser ativado |
|
|
Taxa fixa
|
flat_fee | boolean |
Se a tabela de preços deve usar o preço de taxa fixa |
|
|
Valor do preço
|
value | string |
O valor para o preço resumo |
|
|
Ativado(a)
|
enabled | boolean |
Se o imposto da tabela de preços deve ser ativado |
|
|
Taxa fixa
|
flat_fee | boolean |
Se a tabela de preços deve usar usando impostos de taxa fixa |
|
|
Valor
|
value | string |
O valor do imposto sumário |
|
|
Data de validade
|
expiration_date | date-time |
Data e hora em que o documento deve expirar |
|
|
ID externo
|
external_id | string |
ID do sistema externo para identificação |
|
|
Conteúdo do ficheiro
|
file_content | string |
Conteúdo do arquivo codificado Base64 |
|
|
IDs de arquivo
|
file_ids | string |
IDs de arquivo exclusivos e separados por vírgulas recebidos ao carregar arquivos |
|
|
Nome do ficheiro
|
file_name | string |
Nome do arquivo do documento, com a extensão. Isso será útil para converter diferentes tipos de arquivo. |
|
|
URL do ficheiro
|
file_url | string |
Url para arquivo de documento. Os documentos devem estar disponíveis publicamente para download |
|
|
Enviar automaticamente
|
is_automatic_sending | boolean |
Se o documento deve ser enviado após a criação |
|
|
Enviar lembretes
|
is_reminder_sending | boolean |
Devem ser enviados lembretes automáticos |
|
|
Agendar envio
|
is_scheduled_sending | boolean |
Caso o envio seja agendado para envio no futuro |
|
|
Assinar documento
|
is_signing | boolean |
Caso o documento seja enviado para assinatura |
|
|
Assinatura manuscrita
|
is_signing_biometric | boolean |
Usar assinatura manuscrita |
|
|
Permitir transferência de assinatura
|
is_signing_forward | boolean |
Caso os destinatários possam transferir direitos de assinatura |
|
|
Assinar com iniciais
|
is_signing_initials | boolean |
Assinar documento usando iniciais de destinatário |
|
|
Enviar SMS
|
is_sms_sending | boolean |
Caso o documento seja enviado ao destinatário móvel por mensagem de texto |
|
|
Nome do documento
|
name | True | string |
Insira um nome do documento |
|
Nome da empresa
|
company_name | string |
Nome da empresa do destinatário |
|
|
Número da empresa
|
company_number | string |
Número da empresa do destinatário |
|
|
Email
|
string |
Endereço de e-mail do destinatário |
||
|
Nome próprio
|
first_name | string |
Nome do destinatário |
|
|
Apelido
|
last_name | string |
Apelido do destinatário |
|
|
Telemóvel
|
mobile | string |
Telemóvel em formato internacional |
|
|
Observação
|
note | string |
Nota adicional para um destinatário |
|
|
Ordem de assinatura
|
order_num | integer |
Se a ordem de assinatura estiver ativada |
|
|
Tipo de destinatário
|
role | string |
O tipo de destinatário no documento |
|
|
Função de modelo
|
role_name | string |
O nome da função em um modelo |
|
|
Verificar EID
|
verify_eid | boolean |
Verificar usando EID |
|
|
Tipo de EID
|
verify_eid_type | string |
Tipo de IDE a utilizar para verificação pessoal |
|
|
Ativar pergunta
|
verify_qna | boolean |
Caso seja feita uma pergunta |
|
|
Resposta da verificação
|
verify_qna_answer | string |
A resposta à pergunta |
|
|
Pergunta em aberto
|
verify_qna_open | boolean |
Deve ser feita uma pergunta antes de abrir o documento |
|
|
Pergunta de verificação
|
verify_qna_question | string |
Pergunta a fazer para verificação |
|
|
Pergunta de assinatura
|
verify_qna_sign | boolean |
Deve ser feita uma pergunta antes de assinar |
|
|
Verificar SMS
|
verify_sms | boolean |
Verificar destinatário por SMS |
|
|
Verificar SMS em aberto
|
verify_sms_open | boolean |
Verificar SMS em aberto |
|
|
Verificar por SMS
|
verify_sms_sign | boolean |
Se um SMS verificar o destinatário antes de assinar |
|
|
Agendar data de envio
|
scheduled_sending_time | date-time |
Data e hora em que o documento deve ser enviado |
|
|
Substituição de e-mail do remetente
|
sender_email | string |
Enviar de outro e-mail que não seja usuário autenticado |
|
|
Substituição do usuário remetente
|
sender_id | string |
Enviar de outro usuário que não seja autenticado |
|
|
ID do modelo
|
template_id | string |
Selecione um modelo a ser usado para o envio |
|
|
Tipo de documento
|
type | string |
Definir o tipo/categoria do documento |
|
|
Valor do documento
|
value | integer |
Valor do negócio ou documento |
|
|
ID do vídeo
|
video_id | string |
Selecione um vídeo para usar no envio |
Devoluções
Um documento é um ou vários arquivos carregados que devem ser enviados para um ou vários destinatários criados por um usuário.
- Documento
- Document
Criar utilizador
Isso criará um novo contato no banco de dados para a entidade atual
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
company_name
|
company_name | string |
Nome da empresa associada |
|
|
company_number
|
company_number | string |
Número da empresa associada |
|
|
e-mail
|
string |
Endereço de e-mail do contato |
||
|
first_name
|
first_name | string |
Nome próprio do contacto |
|
|
nome completo
|
fullname | string |
Use para especificar nome completo em vez de nome/sobrenome |
|
|
last_name
|
last_name | string |
Apelido do contacto |
|
|
móvel
|
mobile | string |
Número de telemóvel em formato internacional |
|
|
Observação
|
note | string |
Nota interna opcional para contacto |
|
|
phone
|
phone | string |
Número de telefone em formato internacional |
|
|
title
|
title | string |
O título do contato, ex. CEO, Gerente de vendas |
Devoluções
Um usuário é definido por seu endereço de e-mail e está conectado a uma ou várias entidades.
Funções de Utilizador
Administrador:
- Ver todos os documentos
- Editar todos os documentos
- Alterar configurações, informações e faturamento da entidade
- Adicionar novos usuários à entidade
- Atribuir funções de entidade
Responsável:
- Ver documentos da equipa
- Editar todos os documentos
- Adicionar novos usuários à entidade
Entidade
Uma entidade é o nó superior e todos os usuários e documentos correspondentes estão conectados a uma entidade. Uma entidade é muitas vezes o mesmo que uma empresa, um país ou um departamento numa grande organização.
- User
- User
Descarregar documento
O arquivo de documento sempre pode ser baixado, mas é muito provável que você queira baixá-lo quando ele tiver o status Assinado.
Você pode selecionar para receber um download-url ou obter o arquivo binário.
O URL de download pode ser acessado 10 minutos após a solicitação ter sido feita.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
Retornar o arquivo binário diretamente
|
direct | string |
Retornar o arquivo binário diretamente |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
ficheiro
|
file | string |
Enviar documento existente
Quando você envia um documento via GetAccept, entregamos um e-mail a todos os destinatários, cada um contendo um link exclusivo e seguro. Esta chamada de API aciona a ação de envio de documentos e só pode ser executada em documentos com document_status = rascunho. O documento será enviado aos destinatários que forneceu quando foi criado.
Se o documento foi criado usando a opção de autoassinatura, ele também será autoassinado pelo usuário autenticado ou especificado antes de enviar.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
sender_email
|
sender_email |
Use isso para especificar o usuário/proprietário remetente por endereço de e-mail a ser usado para autoassinar o documento. |
||
|
sender_id
|
sender_id | string |
Use isso para especificar o usuário/proprietário do remetente por id a ser usado para autoassinar o documento. |
Devoluções
Um documento é um ou vários arquivos carregados que devem ser enviados para um ou vários destinatários criados por um usuário.
- Documento
- Document
Lista de utilizadores
Obter uma lista de usuários ativos para a entidade autenticada atual
Devoluções
Lista de utilizadores
- Utilizadores
- Users
Listar anexos
Receba uma lista de anexos disponíveis. Você pode adicionar novos anexos em GetAccept usando um novo documento.
Devoluções
Lista de anexos
- Attachments
- Attachments
Listar contatos
Receba uma lista de contatos disponíveis para a entidade atual. Todos os contatos adicionados como destinatários são salvos como um contato e ficam disponíveis para uso posterior nessa entidade.
Devoluções
Lista de contactos
- Contacts
- Contacts
Listar documentos
Obter uma lista de documentos disponíveis
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lista de filtros no status
|
filter | string |
Lista de filtros no status |
|
|
Como ordenar os resultados
|
sort_by | string |
Como ordenar os resultados |
|
|
Ordem de classificação dos resultados
|
sort_order | string |
Ordem de classificação dos resultados |
|
|
Incluir documentos de membros da equipa
|
showteam | boolean |
Incluir documentos de membros da equipa |
|
|
Incluir todos os documentos da entidade
|
showall | boolean |
Incluir todos os documentos da entidade |
|
|
ID externo
|
external_id | string |
Um ID externo é um campo personalizado que pode conter um identificador de registro exclusivo de um sistema fora do GetAccept |
|
|
Compensação
|
offset | number |
Lista inicial do registro x até o limite |
|
|
Limite
|
limit | number |
Número de registos a listar |
Devoluções
Lista de documentos
- Itens
- Documents
Listar vídeos
Receba uma lista de vídeos disponíveis sobre a entidade. Você pode adicionar novos vídeos no aplicativo móvel ou dentro do GetAccept.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
editável
|
videos.editable | boolean | |
|
publicado em
|
videos.published | boolean | |
|
Salvo
|
videos.saved | boolean | |
|
thumb_url
|
videos.thumb_url | string | |
|
video_id
|
videos.video_id | string | |
|
video_title
|
videos.video_title | string | |
|
video_type
|
videos.video_type | string | |
|
video_url
|
videos.video_url | string |
Modelos de lista
Receba uma lista de modelos de documentos disponíveis. Você pode adicionar novos modelos na seção Modelos em GetAccept.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Mostrar tudo
|
showall | string |
Mostrar todos os modelos para entidade |
|
|
ID da pasta
|
folder_id | string |
Mostrar modelos em uma pasta específica |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
criado_em
|
templates.created_at | string | |
|
external_editor_type
|
templates.external_editor_type | string | |
|
field_count
|
templates.field_count | integer | |
|
id
|
templates.id | string | |
|
is_editable
|
templates.is_editable | boolean | |
|
is_private
|
templates.is_private | boolean | |
|
nome
|
templates.name | string | |
|
page_count
|
templates.page_count | integer | |
|
role_count
|
templates.role_count | integer | |
|
sender_name
|
templates.sender_name | string | |
|
sender_thumb_url
|
templates.sender_thumb_url | string | |
|
thumb_url
|
templates.thumb_url | string | |
|
tipo
|
templates.type | string | |
|
user_id
|
templates.user_id | string | |
|
video_id
|
templates.video_id | string | |
|
video_thumb_url
|
templates.video_thumb_url | string |
Obter anexos de documentos
Obtenha anexos de documentos especificando uma ID de documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Devoluções
Lista de anexos
- Attachments
- Attachments
Obter campos de documento
Obtenha uma lista de campos para um documento ou modelo. Pode ser usado antes e depois da assinatura de um documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Devoluções
Lista de campos
- Campos
- Fields
Obter campos de modelo
Receba uma lista de campos para um modelo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | string |
ID do modelo |
Devoluções
Lista de campos
- Campos
- Fields
Obter destinatários do documento
Obtenha uma lista de destinatários para um documento específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Devoluções
Lista de destinatários
- Destinatários
- Recipients
Obter detalhes do documento
Obtenha detalhes do documento especificando uma ID do documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Devoluções
Um documento é um ou vários arquivos carregados que devem ser enviados para um ou vários destinatários criados por um usuário.
- Documento
- Document
Obter detalhes do utilizador
Esta chamada retornará detalhes de um único usuário. Receber detalhes e entidades disponíveis do usuário autenticado atual usando user-id me
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
ID de utilizador |
Devoluções
Um usuário é definido por seu endereço de e-mail e está conectado a uma ou várias entidades.
Funções de Utilizador
Administrador:
- Ver todos os documentos
- Editar todos os documentos
- Alterar configurações, informações e faturamento da entidade
- Adicionar novos usuários à entidade
- Atribuir funções de entidade
Responsável:
- Ver documentos da equipa
- Editar todos os documentos
- Adicionar novos usuários à entidade
Entidade
Uma entidade é o nó superior e todos os usuários e documentos correspondentes estão conectados a uma entidade. Uma entidade é muitas vezes o mesmo que uma empresa, um país ou um departamento numa grande organização.
- User
- User
Obter funções de modelo
Receba uma lista de funções para um modelo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | string |
ID do modelo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
e-mail
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
móvel
|
roles.mobile | string | |
|
função
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
Obter tabelas de preços de modelo
Receba uma lista de itens da tabela de preços para um modelo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | string |
ID do modelo |
Devoluções
Tabelas de Preços
- Pricing
- PricingTables
Acionadores
| Quando um documento foi revisto |
Aciona quando um documento é revisado por qualquer um dos destinatários |
| Quando um documento é assinado |
Aciona quando um documento é assinado por todas as partes signatárias |
| Quando um documento é rejeitado |
Aciona quando um documento é rejeitado por qualquer um dos destinatários |
| Subscrever eventos de documentos |
Esta chamada criará uma nova assinatura. A resposta será envolvida em uma matriz, mesmo para um único objeto, de acordo com os padrões de gancho REST.
|
Quando um documento foi revisto
Aciona quando um documento é revisado por qualquer um dos destinatários
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Todos os utilizadores da entidade
|
global | boolean |
Se o webhook deve capturar eventos para todos os usuários da entidade. |
|
|
E-mail de erro
|
notification_email | string |
Se o evento falhar, envie uma notificação para este e-mail em vez do remetente |
|
|
Carga útil
|
payload | string |
Dados adicionais de carga útil a serem postados |
Devoluções
Carga útil Webhook
- webhook
- Webhook
Quando um documento é assinado
Aciona quando um documento é assinado por todas as partes signatárias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Todos os utilizadores da entidade
|
global | boolean |
Se o webhook deve capturar eventos para todos os usuários da entidade. |
|
|
E-mail de erro
|
notification_email | string |
Se o evento falhar, envie uma notificação para este e-mail em vez do remetente |
|
|
Carga útil
|
payload | string |
Dados adicionais de carga útil a serem postados |
Devoluções
Carga útil Webhook
- webhook
- Webhook
Quando um documento é rejeitado
Aciona quando um documento é rejeitado por qualquer um dos destinatários
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Todos os utilizadores da entidade
|
global | boolean |
Se o webhook deve capturar eventos para todos os usuários da entidade. |
|
|
E-mail de erro
|
notification_email | string |
Se o evento falhar, envie uma notificação para este e-mail em vez do remetente |
|
|
Carga útil
|
payload | string |
Dados adicionais de carga útil a serem postados |
Devoluções
Carga útil Webhook
- webhook
- Webhook
Subscrever eventos de documentos
Esta chamada criará uma nova assinatura. A resposta será envolvida em uma matriz, mesmo para um único objeto, de acordo com os padrões de gancho REST.
Events
-
document.created- O documento é criado -
document.sent- O documento é enviado -
document.viewed- O documento é enviado -
document.signed- O documento está assinado -
document.approved- Documento aprovado -
document.expired- O documento expirou -
document.rejected- Documento rejeitado -
document.downloaded- O documento é descarregado -
document.printed- O documento é impresso -
document.forwarded- O documento é encaminhado -
document.partially_signed- O documento foi parcialmente assinado -
document.commented- Documento comentado -
document.hardbounced- Documento é hardbounced -
document.imported- O documento é importado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Selecionar evento
|
event | True | string |
Gatilho de evento |
|
Todos os utilizadores da entidade
|
global | boolean |
Se o webhook deve capturar eventos para todos os usuários da entidade. |
|
|
E-mail de erro
|
notification_email | string |
Se o evento falhar, envie uma notificação para este e-mail em vez do remetente |
|
|
Carga útil
|
payload | string |
Dados adicionais de carga útil a serem postados |
Devoluções
Carga útil Webhook
- webhook
- Webhook
Definições
Attachment
Anexo do documento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Destinatários de acesso
|
access_recipient_names | array of string |
Destinatários com acesso ao anexo |
|
Description
|
attachment_description | string |
Descrição do anexo |
|
Download URL
|
attachment_download_url | string |
URL para transferir o anexo |
|
Extensão de Ficheiro
|
attachment_extension | string |
Extensão de arquivo do anexo |
|
Nome do ficheiro
|
attachment_filename | string |
Nome do ficheiro do anexo |
|
ID
|
attachment_id | string |
ID do anexo |
|
URL de pré-visualização
|
attachment_preview_url | string |
URL interna para pré-visualizar o anexo |
|
Title
|
attachment_title | string |
Título do anexo |
|
Tipo
|
attachment_type | string |
Tipo de anexo |
|
URL
|
attachment_url | string |
URL do anexo |
|
Última Vista
|
last_attachment_view | string |
Data e hora em que o anexo foi visualizado pela última vez |
|
Acesso restrito
|
restrict_access | boolean |
O anexo tem acesso restrito |
Attachments
Lista de anexos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
Contato
Cada endereço de e-mail exclusivo (ou número de celular) é definido como um contato.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Empresa
|
company_id | string |
ID da Empresa |
|
Logótipo da empresa
|
company_logo_url | string |
Logótipo da empresa |
|
Nome da empresa
|
company_name | string |
Nome da empresa do contacto |
|
Número da empresa
|
company_number | string |
Número da empresa do contacto |
|
ID de contato
|
contact_id | string |
ID de contato |
|
Criado
|
created_at | string |
Data do contacto criado |
|
Documents
|
document_count | number |
Número de documentos para um contacto |
|
E-mail de contacto
|
string |
Nome do documento criado |
|
|
Nome próprio
|
first_name | string |
Nome próprio do contacto |
|
Nome completo
|
fullname | string |
Nome completo do contacto |
|
Sexo
|
gender | string |
Sexo do beneficiário |
|
Apelido
|
last_name | string |
Apelido do contacto |
|
Telemóvel
|
mobile | string |
Número de telemóvel do contacto |
|
Observação
|
note | string |
Nota do contacto |
|
URL do polegar
|
thumb_url | string |
URL do polegar do contato |
|
Title
|
title | string |
Título do contacto |
Contacts
Lista de contactos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
Documento
Um documento é um ou vários arquivos carregados que devem ser enviados para um ou vários destinatários criados por um usuário.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Etiquetas
|
tags | string |
Tags de documento |
|
Texto de bate-papo automático
|
auto_comment_text | string |
Texto de bate-papo automático |
|
Nome da Empresa
|
company_name | string |
Nome da Empresa |
|
Criado(a) a
|
created_at | string |
Quando o documento foi criado |
|
Download URL
|
download_url | string |
URL para descarregar o documento assinado |
|
Mensagem de e-mail
|
email_send_message | string |
Enviar mensagem de e-mail |
|
Assunto do e-mail
|
email_send_subject | string |
Texto do assunto do e-mail |
|
Data de validade
|
expiration_date | string |
Data de validade do documento |
|
ID do Cliente Externo
|
external_client_id | string | |
|
ID do Editor Externo
|
external_editor_id | string |
ID no editor externo |
|
Tipo de Editor Externo
|
external_editor_type | string | |
|
ID externo
|
external_id | string | |
|
Contagem de campos
|
field_count | integer |
Número de campos no documento |
|
ID
|
id | string | |
|
Comentário automático
|
is_auto_comment | boolean |
Se o comentário automático do chat estiver ativado |
|
E-mail de comentário automático
|
is_auto_comment_email | boolean |
Se o e-mail de chat automático estiver ativado |
|
Identificar destinatário
|
is_identify_recipient | boolean |
Se o documento tiver a identificação do destinatário ativada |
|
É privado
|
is_private | boolean |
Se o documento for privado |
|
Enviar lembretes
|
is_reminder_sending | boolean |
Se os lembretes automáticos estiverem ativados |
|
Envio programado
|
is_scheduled_sending | boolean |
Se o documento tiver envio agendado |
|
Auto-assinatura
|
is_selfsign | boolean |
Se o documento tiver sido autoassinado pelo remetente |
|
Está assinado
|
is_signed | boolean |
Se o documento tiver sido assinado |
|
Documento assinado
|
is_signing | boolean |
Se o documento for assinante |
|
Assinatura manuscrita
|
is_signing_biometric | boolean |
Se a assinatura manuscrita estiver ativada |
|
Permitir transferência de assinatura
|
is_signing_forward | boolean |
Se a transferência de direitos de assinatura estiver habilitada |
|
Ordem de assinatura
|
is_signing_order | boolean |
Se a ordem de assinatura do destinatário estiver ativada |
|
Tem vídeo
|
is_video | boolean |
Se o documento tiver um vídeo de introdução |
|
Nome
|
name | string |
Nome do documento |
|
ID do pai
|
parent_id | string |
ID da versão anterior do documento |
|
URL de pré-visualização
|
preview_url | string |
Link para visualização interna do documento |
|
recipients
|
recipients | array of Recipient | |
|
Hora de envio agendada
|
scheduled_sending_time | string |
Quando o envio do documento foi agendado |
|
Data de envio
|
send_date | string |
Data de envio do documento |
|
E-mail do remetente
|
sender_email | string |
Endereço de e-mail do usuário remetente |
|
Nome do remetente
|
sender_name | string |
Nome do usuário remetente |
|
URL do polegar do remetente
|
sender_thumb_url | string |
Imagem de polegar do usuário remetente |
|
Data de assinatura
|
sign_date | string |
Data de assinatura do documento |
|
Situação
|
status | string |
Estado atual do documento |
|
URL do polegar
|
thumb_url | string |
Imagem do polegar do documento |
|
Tipo
|
type | string |
Tipo de documento |
|
ID Único
|
unique_id | integer |
ID exclusivo para o documento |
|
ID de utilizador
|
user_id | string |
ID do utilizador remetente |
|
Valor
|
value | integer |
Valor do documento |
Documents
Lista de documentos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
criado_em
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
id
|
id | string | |
|
is_private
|
is_private | boolean | |
|
is_signing
|
is_signing | boolean | |
|
nome
|
name | string | |
|
sender_name
|
sender_name | string | |
|
sender_thumb
|
sender_thumb | string | |
|
estado
|
status | string | |
|
tipo
|
type | string | |
|
valor
|
value | integer |
EditorField
Detalhes do campo do editor
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
ID |
|
Etiqueta
|
input_settings.label | string |
Etiqueta |
|
Opções
|
input_settings.options | array of string |
Opções |
|
Obrigatório
|
input_settings.required | boolean |
Obrigatório |
|
Tipo
|
input_settings.type | string |
Tipo |
|
ID do destinatário
|
recipient_id | string |
ID do destinatário |
|
Tipo
|
type | string |
Tipo |
|
ID de utilizador
|
user_id | string |
ID de utilizador |
Campo
Detalhes do campo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome da Empresa
|
company_name | string |
Nome da Empresa |
|
Número da Empresa
|
company_number | string |
Número da Empresa |
|
ID do campo
|
field_id | string |
ID do campo |
|
Etiqueta
|
field_label | string |
Etiqueta |
|
Opções
|
field_options | array of object |
Opções |
|
Valor
|
field_options.value | string | |
|
Tipo
|
field_type | string |
Tipo |
|
Valor
|
field_value | string |
Valor |
|
is_collectable
|
is_collectable | boolean |
Campo coletor |
|
is_editable
|
is_editable | boolean |
Campo editável |
|
is_required
|
is_required | boolean |
Campo obrigatório |
|
ID da página
|
page_id | string |
ID da página |
|
ID do destinatário
|
recipient_id | string |
ID do destinatário |
|
Nome do destinatário
|
recipient_name | string |
Nome do destinatário |
|
Nome do Direito de Acesso
|
role_name | string |
Nome do Direito de Acesso |
Campos
Lista de campos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
campos
|
fields | array of Field |
PreçoColuna
Coluna da tabela de preços
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
column_id | string |
ID |
|
Nome de exibição
|
display_name | string |
Nome de exibição |
|
Ativado(a)
|
enabled | boolean |
Ativado(a) |
|
Nome
|
name | string |
Nome |
Secção de Preços
Secção Tabela de Preços
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Nome de exibição
|
display_name | string |
Nome de exibição |
|
Nome
|
name | string |
Nome |
|
ID
|
section_id | string |
ID |
Tabela de Preços
Tabela de Preços
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Moeda
|
currency_settings.currency | string |
Moeda |
|
Localidade
|
currency_settings.locale | string |
Localidade |
|
Totais pré-calculados
|
pre_calculated | boolean |
Totais pré-calculados |
|
secções
|
sections | array of PricingSection | |
|
ID
|
table_id | string |
ID da tabela |
Tabelas de Preços
Tabelas de Preços
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
Cada endereço de email exclusivo (ou número de celular) conectado a um documento é um destinatário.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome da empresa
|
company_name | string |
Nome da empresa do destinatário |
|
Número da empresa
|
company_number | string |
Número da empresa do destinatário |
|
URL do documento
|
document_url | string |
URL exclusivo para o destinatário visualizar/assinar |
|
E-mail do destinatário
|
string |
E-mail do destinatário |
|
|
Nome próprio
|
first_name | string |
Nome próprio do destinatário |
|
Nome completo
|
fullname | string |
Nome completo do destinatário |
|
Sexo
|
gender | string |
Sexo do beneficiário |
|
ID
|
id | string |
ID do destinatário |
|
Apelido
|
last_name | string |
Apelido do destinatário |
|
Telemóvel
|
mobile | string |
Número de telemóvel do destinatário |
|
Observação
|
note | string |
Nota do destinatário |
|
Assinando o número de ordem
|
order_num | string |
Ordem de assinatura do destinatário |
|
Situação
|
status | string |
Estatuto do destinatário |
|
URL do polegar
|
thumb_url | string |
URL do polegar do destinatário |
|
Title
|
title | string |
Designação do beneficiário |
Destinatários
Lista de destinatários
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient |
User
Um usuário é definido por seu endereço de e-mail e está conectado a uma ou várias entidades.
Funções de Utilizador
Administrador:
- Ver todos os documentos
- Editar todos os documentos
- Alterar configurações, informações e faturamento da entidade
- Adicionar novos usuários à entidade
- Atribuir funções de entidade
Responsável:
- Ver documentos da equipa
- Editar todos os documentos
- Adicionar novos usuários à entidade
Entidade
Uma entidade é o nó superior e todos os usuários e documentos correspondentes estão conectados a uma entidade. Uma entidade é muitas vezes o mesmo que uma empresa, um país ou um departamento numa grande organização.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Modo de aplicativo
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
Email
|
string |
Endereço de e-mail do utilizador |
|
|
ID da entidade
|
entity_id | string | |
|
Nome da Entidade
|
entity_name | string | |
|
Nome próprio
|
first_name | string |
Nome próprio do utilizador |
|
ID
|
id | string |
ID do utilizador |
|
Linguagem
|
language | string | |
|
Apelido
|
last_name | string |
Apelido do utilizador |
|
móvel
|
mobile | string |
Número de telemóvel em formato internacional |
|
Observação
|
note | string |
Nota interna opcional para o utilizador |
|
Telemóvel
|
phone | string |
Número de telefone em formato internacional |
|
Funções
|
role | string | |
|
Ignorar o envio de convite
|
skip_invitation | boolean | |
|
Situação
|
status | string | |
|
ID da Equipa
|
team_id | string | |
|
URL do polegar
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Title
|
title | string |
O título do usuário, ex. CEO, Gerente de vendas |
Utilizadores
Lista de utilizadores
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
users
|
users | array of object | |
|
Email
|
users.email | string | |
|
Nome Próprio
|
users.first_name | string | |
|
Último Login
|
users.last_login | string | |
|
Apelido
|
users.last_name | string | |
|
Nome de Utilizador
|
users.name | string | |
|
Funções
|
users.role | string | |
|
Situação
|
users.status | string | |
|
Nome da Equipa
|
users.team_name | string | |
|
ID de utilizador
|
users.user_id | string |
webhook
Carga útil Webhook
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Campos personalizados
|
custom_fields | object | |
|
Documento
|
document | Document |
Um documento é um ou vários arquivos carregados que devem ser enviados para um ou vários destinatários criados por um usuário. |
|
Domínio personalizado da entidade
|
entity.custom_domain | string |
Configuração de domínio personalizada para entidade |
|
Mensagem de e-mail padrão
|
entity.email_send_message | string |
Mensagem de e-mail padrão |
|
Assunto do e-mail padrão
|
entity.email_send_subject | string |
Assunto do e-mail padrão |
|
Subdomínio da entidade
|
entity.sub_domain | string |
Subdomínio da entidade |
|
Nome do evento
|
event | string | |
|
Ação do evento
|
event_action | string | |
|
Tipo de evento
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
Cada endereço de email exclusivo (ou número de celular) conectado a um documento é um destinatário. |
|
ID da subscrição
|
subscription_id | string |