GetAccept
GetAccept offre una piattaforma di abilitazione delle vendite per la progettazione, l'invio, la promozione, la traccia e l'e-sign dei documenti di vendita, sfruttando la garanzia di vendita, la gestione dei contratti, le proposte e le firme elettroniche in un'unica posizione.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Team dell'API GetAccept |
| URL | https://app.getaccept.com/api |
| integrations@getaccept.com |
| Metadati del connettore | |
|---|---|
| Editore | GetAccept, Inc. |
| Sito web | https://www.getaccept.com |
| Informativa sulla privacy | https://www.getaccept.com/privacy-policy |
| Categorie | Vendite e CRM; Produttività |
GetAccept offre una piattaforma di abilitazione delle vendite per la progettazione, l'invio, la promozione, la traccia e l'e-sign dei documenti di vendita, sfruttando la garanzia di vendita, la gestione dei contratti, le proposte e le firme elettroniche in un'unica posizione. Questo connettore consente di automatizzare i flussi di lavoro per l'archiviazione dei documenti, il recupero, l'assegnazione di attività e le notifiche personalizzate.
Prerequisiti
Per usare questa connessione, è necessario un account GetAccept. Passare a getaccept.com per registrare un account gratuito.
Come ottenere le credenziali?
Solo un account GetAccept valido è obbligatorio perché viene usato OAuth2 per autenticare l'utente connesso corrente in GetAccept.
Problemi noti e limitazioni
Per eventuali problemi correlati all'integrazione, contattare il nostro [mailto:support@getaccept.com](supporto tecnico).
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiornare la scadenza del documento |
Utilizzare questo metodo per aggiornare la data e l'ora di scadenza per un documento. |
| Caricare un allegato |
È possibile caricare file allegati da includere con i documenti inviati. La richiesta con esito positivo restituirà il attachment_id. Utilizzare attachment_id per assegnare un allegato a un documento. |
| Caricare un file di documento |
È possibile caricare un file alla volta e ottenere un ID file. L'ID file viene usato per connettere un file con un documento GetAccept inviato ai destinatari. Se si desidera caricare file mutliple, eseguire più POST. I file vengono accettati solo per impostazione predefinita fino a 10 MB. Il file caricato deve essere importato/aggiunto a un documento entro 48 ore dal caricamento. Ti consigliamo di caricare file PDF per garantire lo stesso aspetto quando inviato. È possibile convertire altri tipi di file, ad esempio: Mirosoft Office: doc, docx, xls, xls, xlsx, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv |
| Caricare un video |
È possibile caricare file allegati da includere con i documenti inviati. La richiesta con esito positivo restituirà il attachment_id. Utilizzare attachment_id per assegnare un allegato a un documento. |
| Crea contatto |
Verrà creato un nuovo contatto nel database per l'entità corrente |
| Creare e inviare un documento o un modello |
È necessario creare un documento per poterlo inviare a un destinatario. Quando si crea un documento, è possibile fare riferimento ai file caricati in precedenza con file_id oppure è possibile scegliere di creare un documento e caricare i file in nel post dell'API. È possibile caricare un solo file quando si include un file nel post di creazione del documento. Usare file_ids parametro per usare file caricati esistenti, file_content per inviare il documento come stringa con codifica Base64 o eseguire un post multipart con il parametro file. Tutti i destinatari devono avere un messaggio di posta elettronica valido o un numero di cellulare. Tutti gli eventi vengono registrati usando l'indirizzo IP del richiedente. È possibile eseguire l'override usando l'intestazione CLIENT_IP contenente l'indirizzo IP pubblico degli utenti finali. |
| Creare un utente |
Verrà creato un nuovo contatto nel database per l'entità corrente |
| Elencare gli allegati |
Ricevere un elenco di allegati disponibili. È possibile aggiungere nuovi allegati in GetAccept usando un nuovo documento. |
| Elencare gli utenti |
Recuperare un elenco di utenti attivi per l'entità autenticata corrente |
| Elencare i contatti |
Ricevere un elenco di contatti disponibili per l'entità corrente. Tutti i contatti aggiunti come destinatario vengono salvati come contatto ed è disponibile per un uso successivo su tale entità. |
| Elencare i documenti |
Ottenere un elenco di documenti disponibili |
| Elencare i modelli |
Ricevere un elenco dei modelli di documento disponibili. È possibile aggiungere nuovi modelli nella sezione Modelli in GetAccept. |
| Elencare i video |
Ricevere un elenco di video disponibili nell'entità. È possibile aggiungere nuovi video nell'app per dispositivi mobili o all'interno di GetAccept. |
| Invia documento esistente |
Quando si invia un documento tramite GetAccept, viene recapitato un messaggio di posta elettronica a tutti i destinatari, ognuno contenente un collegamento univoco e protetto. Questa chiamata API attiva l'azione di invio del documento e può essere eseguita solo sui documenti con document_status = bozza. Il documento verrà inviato ai destinatari specificati al momento della creazione. Se il documento è stato creato usando l'opzione autofirmata, verrà firmato automaticamente anche dall'utente autenticato o specificato prima dell'invio. |
| Ottenere allegati di documenti |
Ottenere gli allegati di documenti specificando un ID documento. |
| Ottenere i campi del documento |
Ottenere un elenco di campi per un documento o un modello. Può essere utilizzato sia prima che dopo la firma di un documento. |
| Ottenere i campi modello |
Ricevere un elenco di campi per un modello specifico. |
| Ottenere i destinatari dei documenti |
Ottenere un elenco di destinatari per un documento specifico. |
| Ottenere i dettagli del documento |
Ottenere i dettagli del documento specificando un ID documento. |
| Ottenere i dettagli utente |
Questa chiamata restituirà i dettagli di un singolo utente. Ricevere i dettagli e le entità disponibili dell'utente autenticato corrente usando l'ID utente |
| Ottenere i ruoli del modello |
Ricevere un elenco di ruoli per un modello specifico. |
| Ottenere le tabelle dei prezzi dei modelli |
Ricevere un elenco di elementi della tabella prezzi per un modello specifico. |
| Scaricare il documento |
Il file di documento può essere sempre scaricato, ma è molto probabile che si voglia scaricarlo quando ha lo stato Signed. È possibile scegliere di ricevere un URL di download o ottenere il file binario. L'URL di download è accessibile 10 minuti dopo che è stata effettuata una richiesta. |
Aggiornare la scadenza del documento
Utilizzare questo metodo per aggiornare la data e l'ora di scadenza per un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID documento |
|
Data di scadenza
|
expiration_date | date-time |
Data e ora di scadenza del documento (UTC) |
|
|
Invia notifica
|
send_notification | boolean |
Deve essere inviata una notifica sull'aggiornamento ai destinatari |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
stato
|
status | integer |
Stato dell'aggiornamento |
Caricare un allegato
È possibile caricare file allegati da includere con i documenti inviati. La richiesta con esito positivo restituirà il attachment_id. Utilizzare attachment_id per assegnare un allegato a un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Contenuto del file
|
file_content | string |
Inviare il file come codificato in base64. Si noti che i file di codifica Base64 aumentano le dimensioni del file con circa 30% |
|
|
Nome del file
|
file_name | string |
Nome file del documento, con l'estensione . Ciò sarà utile per la conversione di diversi tipi di file. |
|
|
File URL
|
file_url | string |
URL del file di documento. Il file deve essere disponibile per il download senza autorizzazione |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Nome del file
|
filename | string |
Nome file dell'allegato |
|
ID allegato
|
id | string |
ID dell'allegato caricato da usare in attachment_id durante la creazione di un documento |
|
Titolo allegato
|
title | string |
Titolo dell'allegato |
|
Tipo di allegato
|
type | string |
Tipo di allegato |
Caricare un file di documento
È possibile caricare un file alla volta e ottenere un ID file. L'ID file viene usato per connettere un file con un documento GetAccept inviato ai destinatari. Se si desidera caricare file mutliple, eseguire più POST. I file vengono accettati solo per impostazione predefinita fino a 10 MB. Il file caricato deve essere importato/aggiunto a un documento entro 48 ore dal caricamento.
Ti consigliamo di caricare file PDF per garantire lo stesso aspetto quando inviato. È possibile convertire altri tipi di file, ad esempio:
Mirosoft Office: doc, docx, xls, xls, xlsx, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Contenuto del file
|
file_content | string |
Inviare il file come codificato in base64. Si noti che i file di codifica Base64 aumentano le dimensioni del file con circa 30% |
|
|
Nome del file
|
file_name | string |
Nome file del documento, con l'estensione . Ciò sarà utile per la conversione di diversi tipi di file. |
|
|
File URL
|
file_url | string |
URL del file di documento. Il file deve essere disponibile per il download senza autorizzazione |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID del file
|
file_id | string |
ID del file caricato da usare in file_ids durante la creazione di un documento |
|
file_status
|
file_status | string |
Stato del file caricato |
Caricare un video
È possibile caricare file allegati da includere con i documenti inviati. La richiesta con esito positivo restituirà il attachment_id. Utilizzare attachment_id per assegnare un allegato a un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Contenuto del file
|
file_content | string |
Inviare il file come codificato in base64. Si noti che i file di codifica Base64 aumentano le dimensioni del file con circa 30% |
|
|
Nome del file
|
file_name | string |
Nome file del documento, con l'estensione . Ciò sarà utile per la conversione di diversi tipi di file. |
|
|
File URL
|
file_url | string |
URL del file di documento. Il file deve essere disponibile per il download senza autorizzazione |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Stato del file
|
file_status | string |
Stato del video |
|
Nome del file
|
filename | string |
Nome file del video |
|
ID lavoro
|
job_id | string |
ID del processo di elaborazione che converte e comprime il video. Eseguire il polling degli aggiornamenti dello stato del processo usando /video/processo/<ID>. |
|
Video ID
|
video_id | string |
ID del video caricato da usare in video_id durante la creazione di un documento |
Crea contatto
Verrà creato un nuovo contatto nel database per l'entità corrente
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome azienda
|
company_name | string |
Nome società associato |
|
|
Numero società
|
company_number | string |
Numero società associato |
|
|
Email
|
string |
Indirizzo di posta elettronica del contatto |
||
|
Nome di battesimo
|
first_name | string |
Nome del contatto |
|
|
Nome completo
|
fullname | string |
Usare per specificare il nome completo anziché il nome/cognome |
|
|
Cognome
|
last_name | string |
Cognome del contatto |
|
|
Dispositivo mobile
|
mobile | string |
Numero di cellulare in formato internazionale |
|
|
Annotazioni
|
note | string |
Nota interna facoltativa per il contatto |
|
|
Telefono
|
phone | string |
Numero di telefono in formato internazionale |
|
|
Titolo
|
title | string |
Titolo del contatto, ad esempio. CEO, Responsabile vendite |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID contatto
|
contact_id | string |
ID del contatto creato |
Creare e inviare un documento o un modello
È necessario creare un documento per poterlo inviare a un destinatario. Quando si crea un documento, è possibile fare riferimento ai file caricati in precedenza con file_id oppure è possibile scegliere di creare un documento e caricare i file in nel post dell'API. È possibile caricare un solo file quando si include un file nel post di creazione del documento.
Usare file_ids parametro per usare file caricati esistenti, file_content per inviare il documento come stringa con codifica Base64 o eseguire un post multipart con il parametro file.
Tutti i destinatari devono avere un messaggio di posta elettronica valido o un numero di cellulare.
Tutti gli eventi vengono registrati usando l'indirizzo IP del richiedente. È possibile eseguire l'override usando l'intestazione CLIENT_IP contenente l'indirizzo IP pubblico degli utenti finali.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Documento d'identità
|
id | string |
ID allegato ricevuto dall'elenco o dopo il caricamento |
|
|
Richiedi visualizzazione
|
require_view | boolean |
Richiedi che il destinatario visualizzi l'allegato |
|
|
TIPO
|
type | string |
file o esterno dove il file è un file caricato ed esterno è un collegamento a un file esterno |
|
|
ID campo
|
id | string |
ID del campo modello personalizzato |
|
|
Nome campo
|
name | string |
Nome del campo modello personalizzato |
|
|
Valore del campo
|
value | string |
Valore del campo modello personalizzato |
|
|
Valuta
|
currency | string |
Valuta, ad esempio SEK |
|
|
Luogo
|
locale | string |
Impostazioni locali, ad esempio sv-SE |
|
|
Nome visualizzato
|
display_name | string |
Nome visualizzato della tabella dei prezzi |
|
|
ID esterno
|
external_id | string |
ID esterno per rappresentare l'oggetto di riepilogo all'interno di un sistema di terze parti |
|
|
ID tabella
|
id | string |
ID tabella |
|
|
Totali precalcolati
|
pre_calculated | boolean |
Se i totali della tabella dei prezzi devono essere precalcosi |
|
|
Nome visualizzato
|
display_name | string |
Nome visualizzato della tabella dei prezzi |
|
|
Documento d'identità
|
id | string |
ID sezione |
|
|
Righe
|
rows |
Matrice con oggetto values con matrice di column_id, valore |
||
|
Enabled
|
enabled | boolean |
Se lo sconto per la sezione deve essere abilitato |
|
|
Tariffa fissa
|
flat_fee | boolean |
Se la sezione deve usare gli sconti per la tariffa fissa |
|
|
Valore sconto
|
value | string |
Valore per lo sconto per la sezione |
|
|
Enabled
|
enabled | boolean |
Se il prezzo della sezione deve essere abilitato |
|
|
Tariffa fissa
|
flat_fee | boolean |
Se la sezione deve usare i prezzi a tariffa fissa |
|
|
Valore prezzo
|
value | string |
Valore per il prezzo di sezione |
|
|
Enabled
|
enabled | boolean |
Se l'imposta di sezione deve essere abilitata |
|
|
Tariffa fissa
|
flat_fee | boolean |
Se la sezione deve usare l'uso delle tasse flat |
|
|
Valore fiscale
|
value | string |
Valore per l'imposta di sezione |
|
|
Enabled
|
enabled | boolean |
Se è necessario abilitare lo sconto per la tabella dei prezzi |
|
|
Tariffa fissa
|
flat_fee | boolean |
Se la tabella dei prezzi deve usare gli sconti a tariffa fissa |
|
|
Valore sconto
|
value | string |
Valore dello sconto riepilogativo |
|
|
Enabled
|
enabled | boolean |
Se è necessario abilitare il prezzo della tabella prezzi |
|
|
Tariffa fissa
|
flat_fee | boolean |
Se la tabella dei prezzi deve usare i prezzi a tariffa fissa |
|
|
Valore prezzo
|
value | string |
Valore per il prezzo di riepilogo |
|
|
Enabled
|
enabled | boolean |
Se è necessario abilitare l'imposta sulla tabella dei prezzi |
|
|
Tariffa fissa
|
flat_fee | boolean |
Se la tabella dei prezzi deve usare l'uso delle imposte flat |
|
|
Value
|
value | string |
Valore per l'imposta di riepilogo |
|
|
Data di scadenza
|
expiration_date | date-time |
Data e ora di scadenza del documento |
|
|
ID esterno
|
external_id | string |
ID sistema esterno per l'identificazione |
|
|
Contenuto del file
|
file_content | string |
Contenuto di file con codifica Base64 |
|
|
ID file
|
file_ids | string |
Id file univoci separati da virgole ricevuti durante il caricamento dei file |
|
|
Nome del file
|
file_name | string |
Nome file del documento, con l'estensione . Ciò sarà utile per la conversione di diversi tipi di file. |
|
|
File URL
|
file_url | string |
URL del file di documento. I documenti devono essere pubblici per il download |
|
|
Invia automaticamente
|
is_automatic_sending | boolean |
Se il documento deve essere inviato dopo la creazione |
|
|
Invia promemoria
|
is_reminder_sending | boolean |
I promemoria automatici devono essere inviati |
|
|
Pianificare l'invio
|
is_scheduled_sending | boolean |
Se l'invio deve essere pianificato per l'invio in futuro |
|
|
Firma documento
|
is_signing | boolean |
Se il documento deve essere inviato per la firma |
|
|
Firma scritta a mano
|
is_signing_biometric | boolean |
Usare la firma scritta a mano |
|
|
Consenti trasferimento della firma
|
is_signing_forward | boolean |
I destinatari devono essere in grado di trasferire i diritti di firma |
|
|
Firma con le iniziali
|
is_signing_initials | boolean |
Firmare il documento usando le iniziali del destinatario |
|
|
Invia SMS
|
is_sms_sending | boolean |
Se il documento deve essere inviato al destinatario mobile in base al testo |
|
|
Nome documento
|
name | True | string |
Immettere un nome del documento |
|
Nome della società
|
company_name | string |
Nome della società del destinatario |
|
|
Numero società
|
company_number | string |
Numero di società del destinatario |
|
|
Email
|
string |
Indirizzo di posta elettronica del destinatario |
||
|
Nome di battesimo
|
first_name | string |
Nome destinatario |
|
|
Cognome
|
last_name | string |
Cognome del destinatario |
|
|
Dispositivo mobile
|
mobile | string |
Telefono cellulare in formato internazionale |
|
|
Annotazioni
|
note | string |
Nota aggiuntiva per un destinatario |
|
|
Ordine di firma
|
order_num | integer |
Se l'ordine di firma è abilitato |
|
|
Tipo di destinatario
|
role | string |
Tipo di destinatario nel documento |
|
|
Ruolo modello
|
role_name | string |
Nome del ruolo in un modello |
|
|
Verificare l'ID EID
|
verify_eid | boolean |
Verificare l'uso di EID |
|
|
Tipo EID
|
verify_eid_type | string |
Tipo EID da usare per la verifica personale |
|
|
Abilitare la domanda
|
verify_qna | boolean |
Dovrebbe essere posta una domanda |
|
|
Risposta di verifica
|
verify_qna_answer | string |
La risposta alla domanda |
|
|
Domanda aperta
|
verify_qna_open | boolean |
La domanda deve essere posta prima di aprire il documento |
|
|
Domanda di verifica
|
verify_qna_question | string |
Domanda da porre per la verifica |
|
|
Domanda di firma
|
verify_qna_sign | boolean |
Prima della firma, è necessario porre una domanda |
|
|
Verificare l'SMS
|
verify_sms | boolean |
Verificare il destinatario tramite SMS |
|
|
Verificare SMS all'apertura
|
verify_sms_open | boolean |
Verificare SMS all'apertura |
|
|
Verifica tramite SMS
|
verify_sms_sign | boolean |
Se un SMS verifica il destinatario prima della firma |
|
|
Pianificare la data di invio
|
scheduled_sending_time | date-time |
Data e ora in cui il documento deve essere inviato |
|
|
Override del messaggio di posta elettronica del mittente
|
sender_email | string |
Inviare da un messaggio di posta elettronica diverso dall'utente autenticato |
|
|
Override dell'utente mittente
|
sender_id | string |
Inviare da un utente diverso dall'autenticazione |
|
|
ID modello
|
template_id | string |
Selezionare un modello da usare per l'invio |
|
|
Tipo di documento
|
type | string |
Impostare il tipo/categoria del documento |
|
|
Valore documento
|
value | integer |
Valore della trattativa o del documento |
|
|
Video ID
|
video_id | string |
Selezionare un video da usare per l'invio |
Restituisce
Un documento è uno o più file caricati che devono essere inviati a uno o più destinatari creati da un utente.
- Documento
- Document
Creare un utente
Verrà creato un nuovo contatto nel database per l'entità corrente
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
company_name
|
company_name | string |
Nome società associato |
|
|
company_number
|
company_number | string |
Numero società associato |
|
|
posta elettronica
|
string |
Indirizzo di posta elettronica del contatto |
||
|
first_name
|
first_name | string |
Nome del contatto |
|
|
fullname
|
fullname | string |
Usare per specificare il nome completo anziché il nome/cognome |
|
|
last_name
|
last_name | string |
Cognome del contatto |
|
|
mobile
|
mobile | string |
Numero di cellulare in formato internazionale |
|
|
nota
|
note | string |
Nota interna facoltativa per il contatto |
|
|
phone
|
phone | string |
Numero di telefono in formato internazionale |
|
|
title
|
title | string |
Titolo del contatto, ad esempio. CEO, Responsabile vendite |
Restituisce
Un utente è definito dall'indirizzo di posta elettronica ed è connesso a una o più entità.
Ruoli utente
Amministratore:
- Visualizzare tutti i documenti
- Modificare tutti i documenti
- Modificare le impostazioni delle entità, le informazioni e la fatturazione
- Aggiungere nuovi utenti all'entità
- Assegnare ruoli di entità
Direttore:
- Visualizzare i documenti del team
- Modificare tutti i documenti
- Aggiungere nuovi utenti all'entità
Entità
Un'entità è il nodo principale e tutti gli utenti e i documenti corrispondenti sono connessi a un'entità. Un'entità è spesso uguale a una società, a un paese o a un reparto in un'organizzazione di grandi dimensioni.
- User
- User
Elencare gli allegati
Ricevere un elenco di allegati disponibili. È possibile aggiungere nuovi allegati in GetAccept usando un nuovo documento.
Restituisce
Elenco allegati
- Attachments
- Attachments
Elencare gli utenti
Recuperare un elenco di utenti attivi per l'entità autenticata corrente
Restituisce
Elenco utenti
- Users
- Users
Elencare i contatti
Ricevere un elenco di contatti disponibili per l'entità corrente. Tutti i contatti aggiunti come destinatario vengono salvati come contatto ed è disponibile per un uso successivo su tale entità.
Restituisce
Elenco contatti
- Contatti
- Contacts
Elencare i documenti
Ottenere un elenco di documenti disponibili
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Filtrare l'elenco in base allo stato
|
filter | string |
Filtrare l'elenco in base allo stato |
|
|
Come ordinare i risultati
|
sort_by | string |
Come ordinare i risultati |
|
|
Ordinamento dei risultati
|
sort_order | string |
Ordinamento dei risultati |
|
|
Includere documenti dai membri del team
|
showteam | boolean |
Includere documenti dai membri del team |
|
|
Includere tutti i documenti dall'entità
|
showall | boolean |
Includere tutti i documenti dall'entità |
|
|
ID esterno
|
external_id | string |
Un ID esterno è un campo personalizzato che può contenere un identificatore di record univoco da un sistema esterno a GetAccept |
|
|
Offset
|
offset | number |
Inizio elenco da record x fino al limite |
|
|
Limite
|
limit | number |
Numero di record da elencare |
Restituisce
Elenco documenti
- Elementi
- Documents
Elencare i modelli
Ricevere un elenco dei modelli di documento disponibili. È possibile aggiungere nuovi modelli nella sezione Modelli in GetAccept.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Mostra tutto
|
showall | string |
Mostra tutti i modelli per l'entità |
|
|
ID cartella
|
folder_id | string |
Visualizzare i modelli in una cartella specifica |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
creato_il
|
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 | |
|
type
|
templates.type | string | |
|
user_id
|
templates.user_id | string | |
|
video_id
|
templates.video_id | string | |
|
video_thumb_url
|
templates.video_thumb_url | string |
Elencare i video
Ricevere un elenco di video disponibili nell'entità. È possibile aggiungere nuovi video nell'app per dispositivi mobili o all'interno di GetAccept.
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
editabile
|
videos.editable | boolean | |
|
edito
|
videos.published | boolean | |
|
salvato
|
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 |
Invia documento esistente
Quando si invia un documento tramite GetAccept, viene recapitato un messaggio di posta elettronica a tutti i destinatari, ognuno contenente un collegamento univoco e protetto. Questa chiamata API attiva l'azione di invio del documento e può essere eseguita solo sui documenti con document_status = bozza. Il documento verrà inviato ai destinatari specificati al momento della creazione.
Se il documento è stato creato usando l'opzione autofirmata, verrà firmato automaticamente anche dall'utente autenticato o specificato prima dell'invio.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID documento |
|
sender_email
|
sender_email |
Utilizzare questa opzione per specificare l'utente/proprietario del mittente in base all'indirizzo di posta elettronica da usare per la firma automatica del documento. |
||
|
sender_id
|
sender_id | string |
Utilizzare questa opzione per specificare l'utente/proprietario del mittente in base all'ID da usare per la firma automatica del documento. |
Restituisce
Un documento è uno o più file caricati che devono essere inviati a uno o più destinatari creati da un utente.
- Documento
- Document
Ottenere allegati di documenti
Ottenere gli allegati di documenti specificando un ID documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID documento |
Restituisce
Elenco allegati
- Attachments
- Attachments
Ottenere i campi del documento
Ottenere un elenco di campi per un documento o un modello. Può essere utilizzato sia prima che dopo la firma di un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID documento |
Restituisce
Elenco campi
- Fields
- Fields
Ottenere i campi modello
Ricevere un elenco di campi per un modello specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID modello
|
templateId | True | string |
ID modello |
Restituisce
Elenco campi
- Fields
- Fields
Ottenere i destinatari dei documenti
Ottenere un elenco di destinatari per un documento specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID documento |
Restituisce
Elenco destinatari
- Destinatari
- Recipients
Ottenere i dettagli del documento
Ottenere i dettagli del documento specificando un ID documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID documento |
Restituisce
Un documento è uno o più file caricati che devono essere inviati a uno o più destinatari creati da un utente.
- Documento
- Document
Ottenere i dettagli utente
Questa chiamata restituirà i dettagli di un singolo utente. Ricevere i dettagli e le entità disponibili dell'utente autenticato corrente usando l'ID utente
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID utente
|
userId | True | string |
ID utente |
Restituisce
Un utente è definito dall'indirizzo di posta elettronica ed è connesso a una o più entità.
Ruoli utente
Amministratore:
- Visualizzare tutti i documenti
- Modificare tutti i documenti
- Modificare le impostazioni delle entità, le informazioni e la fatturazione
- Aggiungere nuovi utenti all'entità
- Assegnare ruoli di entità
Direttore:
- Visualizzare i documenti del team
- Modificare tutti i documenti
- Aggiungere nuovi utenti all'entità
Entità
Un'entità è il nodo principale e tutti gli utenti e i documenti corrispondenti sono connessi a un'entità. Un'entità è spesso uguale a una società, a un paese o a un reparto in un'organizzazione di grandi dimensioni.
- User
- User
Ottenere i ruoli del modello
Ricevere un elenco di ruoli per un modello specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID modello
|
templateId | True | string |
ID modello |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
posta elettronica
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
mobile
|
roles.mobile | string | |
|
ruolo
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
Ottenere le tabelle dei prezzi dei modelli
Ricevere un elenco di elementi della tabella prezzi per un modello specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID modello
|
templateId | True | string |
ID modello |
Restituisce
Tabelle dei prezzi
- Pricing
- PricingTables
Scaricare il documento
Il file di documento può essere sempre scaricato, ma è molto probabile che si voglia scaricarlo quando ha lo stato Signed.
È possibile scegliere di ricevere un URL di download o ottenere il file binario.
L'URL di download è accessibile 10 minuti dopo che è stata effettuata una richiesta.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID documento |
|
Restituire direttamente il file binario
|
direct | string |
Restituire direttamente il file binario |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
documento
|
file | string |
Trigger
| Quando un documento è stato esaminato |
Attiva quando un documento è stato esaminato da uno dei destinatari |
| Quando un documento è stato firmato |
Attiva quando un documento è stato firmato da tutte le parti di firma |
| Quando un documento è stato rifiutato |
Attiva quando un documento è stato rifiutato da uno dei destinatari |
| Sottoscrivere gli eventi del documento |
Questa chiamata creerà una nuova sottoscrizione. La risposta verrà sottoposta a wrapping in una matrice anche per un singolo oggetto in base agli standard di hook REST.
|
Quando un documento è stato esaminato
Attiva quando un documento è stato esaminato da uno dei destinatari
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Tutti gli utenti di entità
|
global | boolean |
Se il webhook deve intercettare gli eventi per tutti gli utenti di entità. |
|
|
Messaggio di posta elettronica di errore
|
notification_email | string |
Se l'evento ha esito negativo, inviare una notifica a questo messaggio di posta elettronica anziché al mittente |
|
|
Payload
|
payload | string |
Dati di payload aggiuntivi da pubblicare |
Restituisce
Payload del webhook
- Webhook
- Webhook
Quando un documento è stato firmato
Attiva quando un documento è stato firmato da tutte le parti di firma
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Tutti gli utenti di entità
|
global | boolean |
Se il webhook deve intercettare gli eventi per tutti gli utenti di entità. |
|
|
Messaggio di posta elettronica di errore
|
notification_email | string |
Se l'evento ha esito negativo, inviare una notifica a questo messaggio di posta elettronica anziché al mittente |
|
|
Payload
|
payload | string |
Dati di payload aggiuntivi da pubblicare |
Restituisce
Payload del webhook
- Webhook
- Webhook
Quando un documento è stato rifiutato
Attiva quando un documento è stato rifiutato da uno dei destinatari
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Tutti gli utenti di entità
|
global | boolean |
Se il webhook deve intercettare gli eventi per tutti gli utenti di entità. |
|
|
Messaggio di posta elettronica di errore
|
notification_email | string |
Se l'evento ha esito negativo, inviare una notifica a questo messaggio di posta elettronica anziché al mittente |
|
|
Payload
|
payload | string |
Dati di payload aggiuntivi da pubblicare |
Restituisce
Payload del webhook
- Webhook
- Webhook
Sottoscrivere gli eventi del documento
Questa chiamata creerà una nuova sottoscrizione. La risposta verrà sottoposta a wrapping in una matrice anche per un singolo oggetto in base agli standard di hook REST.
Events
-
document.created- Il documento viene creato -
document.sent- Il documento viene inviato -
document.viewed- Il documento viene inviato -
document.signed- Il documento è firmato -
document.approved- Il documento è approvato -
document.expired- Il documento è scaduto -
document.rejected- Il documento viene rifiutato -
document.downloaded- Il documento viene scaricato -
document.printed- Documento stampato -
document.forwarded- Il documento viene inoltrato -
document.partially_signed- Il documento è stato firmato parzialmente -
document.commented- Il documento è commentato -
document.hardbounced- Il documento è hardbounced -
document.imported- Il documento viene importato
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Selezionare l'evento
|
event | True | string |
Attivazione evento |
|
Tutti gli utenti di entità
|
global | boolean |
Se il webhook deve intercettare gli eventi per tutti gli utenti di entità. |
|
|
Messaggio di posta elettronica di errore
|
notification_email | string |
Se l'evento ha esito negativo, inviare una notifica a questo messaggio di posta elettronica anziché al mittente |
|
|
Payload
|
payload | string |
Dati di payload aggiuntivi da pubblicare |
Restituisce
Payload del webhook
- Webhook
- Webhook
Definizioni
Attachment
Allegato documento
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Destinatari di accesso
|
access_recipient_names | array of string |
Destinatari con accesso all'allegato |
|
Description
|
attachment_description | string |
Descrizione dell'allegato |
|
Scaricare l'URL
|
attachment_download_url | string |
URL per scaricare l'allegato |
|
Estensione
|
attachment_extension | string |
Estensione del file dell'allegato |
|
Filename
|
attachment_filename | string |
Nome file dell'allegato |
|
Documento d'identità
|
attachment_id | string |
ID dell'allegato |
|
URL di anteprima
|
attachment_preview_url | string |
URL interno per visualizzare in anteprima l'allegato |
|
Titolo
|
attachment_title | string |
Titolo dell'allegato |
|
TIPO
|
attachment_type | string |
Tipo di allegato |
|
URL
|
attachment_url | string |
URL dell'allegato |
|
Ultima visualizzazione
|
last_attachment_view | string |
Data e ora dell'ultima visualizzazione dell'allegato |
|
Accesso con restrizioni
|
restrict_access | boolean |
L'allegato ha accesso limitato |
Attachments
Elenco allegati
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
Contatto
Ogni indirizzo di posta elettronica univoco (o numero di cellulare) viene definito come contatto.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID società
|
company_id | string |
ID società |
|
Logo aziendale
|
company_logo_url | string |
Logo aziendale |
|
Nome della società
|
company_name | string |
Nome della società del contatto |
|
Numero società
|
company_number | string |
Numero di società del contatto |
|
ID contatto
|
contact_id | string |
ID contatto |
|
Created
|
created_at | string |
Data di creazione del contatto |
|
Documents
|
document_count | number |
Numero di documenti per un contatto |
|
Indirizzo di posta elettronica di contatto
|
string |
Nome del documento creato |
|
|
Nome di battesimo
|
first_name | string |
Nome del contatto |
|
Nome completo
|
fullname | string |
Nome completo del contatto |
|
Sesso
|
gender | string |
Sesso del destinatario |
|
Cognome
|
last_name | string |
Cognome del contatto |
|
Dispositivo mobile
|
mobile | string |
Numero di cellulare del contatto |
|
Annotazioni
|
note | string |
Nota del contatto |
|
URL di identificazione personale
|
thumb_url | string |
URL personale del contatto |
|
Titolo
|
title | string |
Titolo del contatto |
Contatti
Elenco contatti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
Documento
Un documento è uno o più file caricati che devono essere inviati a uno o più destinatari creati da un utente.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Etichette
|
tags | string |
Tag documento |
|
Testo automatico della chat
|
auto_comment_text | string |
Testo automatico della chat |
|
Nome azienda
|
company_name | string |
Nome azienda |
|
Ora di creazione
|
created_at | string |
Al momento della creazione del documento |
|
Scaricare l'URL
|
download_url | string |
URL per scaricare il documento firmato |
|
Messaggio di posta elettronica
|
email_send_message | string |
Invio di messaggi di posta elettronica |
|
Oggetto del messaggio di posta elettronica
|
email_send_subject | string |
Testo dell'oggetto del messaggio di posta elettronica |
|
Data di scadenza
|
expiration_date | string |
Data di scadenza del documento |
|
ID client esterno
|
external_client_id | string | |
|
ID editor esterno
|
external_editor_id | string |
ID nell'editor esterno |
|
Tipo di editor esterno
|
external_editor_type | string | |
|
ID esterno
|
external_id | string | |
|
Conteggio campi
|
field_count | integer |
Numero di campi nel documento |
|
Documento d'identità
|
id | string | |
|
Commento automatico
|
is_auto_comment | boolean |
Se il commento automatico della chat è abilitato |
|
Posta elettronica commento automatico
|
is_auto_comment_email | boolean |
Se la posta elettronica di chat automatica è abilitata |
|
Identificare il destinatario
|
is_identify_recipient | boolean |
Se il documento identifica il destinatario abilitato |
|
È privato
|
is_private | boolean |
Se il documento è privato |
|
Invia promemoria
|
is_reminder_sending | boolean |
Se i promemoria automatici sono abilitati |
|
Invio pianificato
|
is_scheduled_sending | boolean |
Se il documento ha pianificato l'invio |
|
Firma automatica
|
is_selfsign | boolean |
Se il documento è stato autofirmato dal mittente |
|
È firmato
|
is_signed | boolean |
Se il documento è stato firmato |
|
Documento firmabile
|
is_signing | boolean |
Se il documento è firmabile |
|
Firma scritta a mano
|
is_signing_biometric | boolean |
Se la firma scritta a mano è abilitata |
|
Consenti trasferimento della firma
|
is_signing_forward | boolean |
Se il trasferimento dei diritti di firma è abilitato |
|
Ordine della firma
|
is_signing_order | boolean |
Se l'ordine di firma del destinatario è abilitato |
|
Ha video
|
is_video | boolean |
Se il documento ha un video introduttivo |
|
Nome
|
name | string |
Nome del documento |
|
ID padre
|
parent_id | string |
ID della versione precedente del documento |
|
URL di anteprima
|
preview_url | string |
Collegamento all'anteprima interna del documento |
|
Destinatari
|
recipients | array of Recipient | |
|
Ora di invio pianificata
|
scheduled_sending_time | string |
Quando il documento è stato pianificato per l'invio |
|
Data di invio
|
send_date | string |
Data di invio documento |
|
Messaggio di posta elettronica del mittente
|
sender_email | string |
Indirizzo di posta elettronica dell'utente mittente |
|
Nome mittente
|
sender_name | string |
Nome utente mittente |
|
URL personale del mittente
|
sender_thumb_url | string |
Immagine personale dell'utente mittente |
|
Data di firma
|
sign_date | string |
Data di firma documento |
|
stato
|
status | string |
Stato corrente del documento |
|
URL di identificazione personale
|
thumb_url | string |
Immagine personale del documento |
|
TIPO
|
type | string |
Tipo di documento |
|
ID univoco
|
unique_id | integer |
ID univoco per il documento |
|
ID utente
|
user_id | string |
ID dell'utente mittente |
|
Value
|
value | integer |
Valore del documento |
Documents
Elenco documenti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
creato_il
|
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 | |
|
status
|
status | string | |
|
type
|
type | string | |
|
value
|
value | integer |
EditorField
Dettagli campo editor
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
Documento d'identità |
|
Etichetta
|
input_settings.label | string |
Etichetta |
|
Options
|
input_settings.options | array of string |
Options |
|
Obbligatorio
|
input_settings.required | boolean |
Obbligatorio |
|
TIPO
|
input_settings.type | string |
TIPO |
|
ID destinatario
|
recipient_id | string |
ID destinatario |
|
TIPO
|
type | string |
TIPO |
|
ID utente
|
user_id | string |
ID utente |
Campo
Dettagli campo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Nome azienda
|
company_name | string |
Nome azienda |
|
Numero società
|
company_number | string |
Numero società |
|
ID campo
|
field_id | string |
ID campo |
|
Etichetta
|
field_label | string |
Etichetta |
|
Options
|
field_options | array of object |
Options |
|
Value
|
field_options.value | string | |
|
TIPO
|
field_type | string |
TIPO |
|
Value
|
field_value | string |
Value |
|
is_collectable
|
is_collectable | boolean |
Campo raccolta |
|
is_editable
|
is_editable | boolean |
Campo modificabile |
|
is_required
|
is_required | boolean |
Campo obbligatorio |
|
ID pagina
|
page_id | string |
ID pagina |
|
ID destinatario
|
recipient_id | string |
ID destinatario |
|
Nome destinatario
|
recipient_name | string |
Nome destinatario |
|
Nome ruolo
|
role_name | string |
Nome ruolo |
Fields
Elenco campi
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
fields
|
fields | array of Field |
PricingColumn
Colonna Tabella prezzi
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
column_id | string |
Documento d'identità |
|
Nome visualizzato
|
display_name | string |
Nome visualizzato |
|
Enabled
|
enabled | boolean |
Enabled |
|
Nome
|
name | string |
Nome |
PricingSection
Sezione Tabella prezzi
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Nome visualizzato
|
display_name | string |
Nome visualizzato |
|
Nome
|
name | string |
Nome |
|
Documento d'identità
|
section_id | string |
Documento d'identità |
PricingTable
Tabella prezzi
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Valuta
|
currency_settings.currency | string |
Valuta |
|
Luogo
|
currency_settings.locale | string |
Luogo |
|
Totali precalcosi
|
pre_calculated | boolean |
Totali precalcosi |
|
Sezioni
|
sections | array of PricingSection | |
|
Documento d'identità
|
table_id | string |
ID tabella |
Tabelle prezzi
Tabelle dei prezzi
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Destinatario
Ogni indirizzo di posta elettronica univoco (o numero di cellulare) connesso a un documento è un destinatario.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Nome della società
|
company_name | string |
Nome della società del destinatario |
|
Numero società
|
company_number | string |
Numero di società del destinatario |
|
URL documento
|
document_url | string |
URL univoco per il destinatario da visualizzare/firmare |
|
Messaggio di posta elettronica destinatario
|
string |
Indirizzo di posta elettronica del destinatario |
|
|
Nome di battesimo
|
first_name | string |
Nome del destinatario |
|
Nome completo
|
fullname | string |
Nome completo del destinatario |
|
Sesso
|
gender | string |
Sesso del destinatario |
|
Documento d'identità
|
id | string |
ID del destinatario |
|
Cognome
|
last_name | string |
Cognome del destinatario |
|
Dispositivo mobile
|
mobile | string |
Numero di cellulare del destinatario |
|
Annotazioni
|
note | string |
Nota del destinatario |
|
Numero ordine di firma
|
order_num | string |
Ordine di firma del destinatario |
|
stato
|
status | string |
Stato del destinatario |
|
URL di identificazione personale
|
thumb_url | string |
URL personale del destinatario |
|
Titolo
|
title | string |
Titolo del destinatario |
Destinatari
Elenco destinatari
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Destinatari
|
recipients | array of Recipient |
User
Un utente è definito dall'indirizzo di posta elettronica ed è connesso a una o più entità.
Ruoli utente
Amministratore:
- Visualizzare tutti i documenti
- Modificare tutti i documenti
- Modificare le impostazioni delle entità, le informazioni e la fatturazione
- Aggiungere nuovi utenti all'entità
- Assegnare ruoli di entità
Direttore:
- Visualizzare i documenti del team
- Modificare tutti i documenti
- Aggiungere nuovi utenti all'entità
Entità
Un'entità è il nodo principale e tutti gli utenti e i documenti corrispondenti sono connessi a un'entità. Un'entità è spesso uguale a una società, a un paese o a un reparto in un'organizzazione di grandi dimensioni.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Modalità app
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
Email
|
string |
Indirizzo di posta elettronica dell'utente |
|
|
ID entità
|
entity_id | string | |
|
Nome entità
|
entity_name | string | |
|
Nome di battesimo
|
first_name | string |
Nome dell'utente |
|
Documento d'identità
|
id | string |
ID dell'utente |
|
Language
|
language | string | |
|
Cognome
|
last_name | string |
Cognome dell'utente |
|
mobile
|
mobile | string |
Numero di cellulare in formato internazionale |
|
Annotazioni
|
note | string |
Nota interna facoltativa per l'utente |
|
Telefono
|
phone | string |
Numero di telefono in formato internazionale |
|
Ruolo
|
role | string | |
|
Ignorare l'invio dell'invito
|
skip_invitation | boolean | |
|
stato
|
status | string | |
|
ID squadra
|
team_id | string | |
|
URL di identificazione personale
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Titolo
|
title | string |
Titolo dell'utente, ad esempio. CEO, Responsabile vendite |
Users
Elenco utenti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
users
|
users | array of object | |
|
Email
|
users.email | string | |
|
Nome di battesimo
|
users.first_name | string | |
|
Ultimo accesso
|
users.last_login | string | |
|
Cognome
|
users.last_name | string | |
|
Nome utente
|
users.name | string | |
|
Ruolo
|
users.role | string | |
|
stato
|
users.status | string | |
|
Nome team
|
users.team_name | string | |
|
ID utente
|
users.user_id | string |
Webhook
Payload del webhook
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Campi personalizzati
|
custom_fields | object | |
|
Documento
|
document | Document |
Un documento è uno o più file caricati che devono essere inviati a uno o più destinatari creati da un utente. |
|
Dominio personalizzato dell'entità
|
entity.custom_domain | string |
Impostazione del dominio personalizzata per l'entità |
|
Messaggio di posta elettronica predefinito
|
entity.email_send_message | string |
Messaggio di posta elettronica predefinito |
|
Oggetto di posta elettronica predefinito
|
entity.email_send_subject | string |
Oggetto di posta elettronica predefinito |
|
Sottodominio dell'entità
|
entity.sub_domain | string |
Sottodominio per l'entità |
|
Nome evento
|
event | string | |
|
Azione evento
|
event_action | string | |
|
Tipo di evento
|
event_type | string | |
|
Destinatario
|
recipient | Recipient |
Ogni indirizzo di posta elettronica univoco (o numero di cellulare) connesso a un documento è un destinatario. |
|
ID sottoscrizione
|
subscription_id | string |