GetAccept
GetAccept tillhandahåller en plattform för säljaktivering för försäljning för att utforma, skicka, marknadsföra, spåra och e-signera försäljningsdokument, utnyttja säljsäkerhet, kontraktshantering, förslag och elektroniska signaturer på ett och samma ställe.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | GetAccept API Team |
| URL | https://app.getaccept.com/api |
| E-postmeddelande | integrations@getaccept.com |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | GetAccept, Inc. |
| Webbplats | https://www.getaccept.com |
| Sekretesspolicy | https://www.getaccept.com/privacy-policy |
| Kategorier | Försäljning och CRM; Produktivitet |
GetAccept tillhandahåller en plattform för säljaktivering för försäljning för att utforma, skicka, marknadsföra, spåra och e-signera försäljningsdokument, utnyttja säljsäkerhet, kontraktshantering, förslag och elektroniska signaturer på ett och samma ställe. Den här anslutningsappen hjälper dig att automatisera dina arbetsflöden för dokumentlagring, hämtning, uppgiftstilldelning och anpassade meddelanden.
Förutsättningar
Ett GetAccept-konto krävs för att använda den här anslutningen. Gå till getaccept.com för att registrera ett kostnadsfritt konto.
Hur hämtar jag autentiseringsuppgifter?
Endast ett giltigt GetAccept-konto krävs eftersom OAuth2 används för att autentisera den aktuella inloggade användaren i GetAccept.
Kända problem och begränsningar
Kontakta vår [mailto:support@getaccept.com](teknisk support) för eventuella integreringsrelaterade problem.
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Förfallodatum för uppdatera dokument |
Använd den här metoden för att uppdatera förfallodatum och tid för ett dokument. |
| Hämta användarinformation |
Det här anropet returnerar information om en enskild användare. Ta emot information och tillgängliga entiteter för den aktuella autentiserade användaren med hjälp av användar-ID mig |
| Hämta dokumentbilagor |
Hämta dokumentbilagor genom att ange ett dokument-ID. |
| Hämta dokumentfält |
Hämta en lista med fält för ett dokument eller en mall. Kan användas både före och efter att ett dokument har signerats. |
| Hämta dokumentinformation |
Hämta dokumentinformation genom att ange ett dokument-ID. |
| Hämta dokumentmottagare |
Hämta en lista över mottagare för ett visst dokument. |
| Hämta mallfält |
Ta emot en lista med fält för en specifik mall. |
| Hämta mallroller |
Ta emot en lista över roller för en specifik mall. |
| Hämta pristabeller för mallar |
Ta emot en lista med pristabellobjekt för en specifik mall. |
| Ladda ned dokument |
Dokumentfilen kan alltid laddas ned, men troligtvis vill du ladda ned den när den har statusen Signerad. Du kan välja att ta emot en nedladdnings-URL eller hämta den binära filen. Nedladdnings-URL:en kan nås 10 minuter efter att en begäran har gjorts. |
| Ladda upp en bifogad fil |
Du kan ladda upp bifogade filer som ska inkluderas med dokument som du skickar. En lyckad begäran returnerar attachment_id. Använd attachment_id för att tilldela en bifogad fil till ett dokument. |
| Ladda upp en dokumentfil |
Du kan ladda upp en fil i taget och hämta ett fil-ID. Fil-ID:t används för att ansluta en fil med ett GetAccept-dokument som skickas till mottagarna. Om du vill ladda upp mutliple-filer kör du flera POST. Vi accepterar endast filer upp till 10 MB som standard. Den uppladdade filen måste importeras/läggas till i ett dokument inom 48 timmar efter uppladdningen. Vi rekommenderar att du laddar upp PDF-filer för att garantera samma utseende när de skickas. Andra filtyper kan konverteras, till exempel: Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv |
| Ladda upp en video |
Du kan ladda upp bifogade filer som ska inkluderas med dokument som du skickar. En lyckad begäran returnerar attachment_id. Använd attachment_id för att tilldela en bifogad fil till ett dokument. |
| Lista användare |
Hämta en lista över aktiva användare för den aktuella autentiserade entiteten |
| Lista mallar |
Ta emot en lista över tillgängliga dokumentmallar. Du kan lägga till nya mallar under avsnittet Mallar i GetAccept. |
| Skapa användare |
Då skapas en ny kontakt i databasen för den aktuella entiteten |
| Skapa kontakt |
Då skapas en ny kontakt i databasen för den aktuella entiteten |
| Skapa och skicka dokument eller mall |
Du måste skapa ett dokument för att kunna skicka det till en mottagare. När du skapar ett dokument kan du referera till tidigare uppladdade filer med file_id eller så kan du välja att skapa ett dokument och ladda upp filerna i ett API-inlägg. Du kan bara ladda upp en fil när du inkluderar en fil i skapa dokumentet POST. Använd antingen file_ids parameter för att använda befintliga uppladdade filer, file_content för att skicka dokumentet som base64-kodad sträng eller göra ett inlägg med flera delar med filparametern. Alla mottagare måste ha antingen ett giltigt e-postmeddelande eller ett mobilnummer. Alla händelser registreras med ip-adressen för beställaren. Du kan åsidosätta detta med hjälp av rubrik CLIENT_IP som innehåller slutanvändarens offentliga IP-adress. |
| Skicka befintligt dokument |
När du skickar ett dokument via GetAccept skickar vi ett e-postmeddelande till alla mottagare som var och en innehåller en unik, skyddad länk. Det här API-anropet utlöser åtgärden skicka dokument och kan endast utföras på dokument med document_status = utkast. Dokumentet skickas till mottagare som du angav när det skapades. Om dokumentet har skapats med självsigneringsalternativet kommer det också att vara självsignerat av den autentiserade eller angivna användaren innan det skickas. |
| Visa en lista med videor |
Ta emot en lista över tillgängliga videor på entiteten. Du kan lägga till nya videor i mobilappen eller i GetAccept. |
| Visa en lista över bifogade filer |
Ta emot en lista över tillgängliga bifogade filer. Du kan lägga till nya bifogade filer i GetAccept med hjälp av ett nytt dokument. |
| Visa en lista över dokument |
Hämta en lista över tillgängliga dokument |
| Visa en lista över kontakter |
Ta emot en lista över tillgängliga kontakter för den aktuella entiteten. Alla kontakter som läggs till som mottagare sparas som en kontakt och är tillgängliga för senare användning på den entiteten. |
Förfallodatum för uppdatera dokument
Använd den här metoden för att uppdatera förfallodatum och tid för ett dokument.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
|
Förfallodatum
|
expiration_date | date-time |
Datum och tid när dokumentet ska upphöra att gälla (UTC) |
|
|
Skicka meddelande
|
send_notification | boolean |
Om ett meddelande om uppdateringen skickas till mottagarna |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Läge
|
status | integer |
Status för uppdatering |
Hämta användarinformation
Det här anropet returnerar information om en enskild användare. Ta emot information och tillgängliga entiteter för den aktuella autentiserade användaren med hjälp av användar-ID mig
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Användar-ID
|
userId | True | string |
Användar-ID |
Returer
En användare definieras av sin e-postadress och är ansluten till en eller flera entiteter.
Användarroller
Administratör:
- Visa alla dokument
- Redigera alla dokument
- Ändra entitetsinställningar, information och fakturering
- Lägga till nya användare i entiteten
- Tilldela entitetsroller
Föreståndare:
- Visa gruppdokument
- Redigera alla dokument
- Lägga till nya användare i entiteten
Enhet
En entitet är den översta noden och alla användare och motsvarande dokument är anslutna till en entitet. En entitet är ofta densamma som ett företag, ett land eller en avdelning i en stor organisation.
- User
- User
Hämta dokumentbilagor
Hämta dokumentbilagor genom att ange ett dokument-ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
Returer
Lista över bifogade filer
- Attachments
- Attachments
Hämta dokumentfält
Hämta en lista med fält för ett dokument eller en mall. Kan användas både före och efter att ett dokument har signerats.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
Returer
Fältlista
- Fields
- Fields
Hämta dokumentinformation
Hämta dokumentinformation genom att ange ett dokument-ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
Returer
Ett dokument är en eller flera uppladdade filer som ska skickas till en eller flera mottagare som skapats av en användare.
- Dokument
- Document
Hämta dokumentmottagare
Hämta en lista över mottagare för ett visst dokument.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
Returer
Mottagarlista
- Mottagare
- Recipients
Hämta mallfält
Ta emot en lista med fält för en specifik mall.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Mall-id
|
templateId | True | string |
Mall-id |
Returer
Fältlista
- Fields
- Fields
Hämta mallroller
Ta emot en lista över roller för en specifik mall.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Mall-id
|
templateId | True | string |
Mall-id |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
Mejladress
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
mobile
|
roles.mobile | string | |
|
None needed, as the translation is already accurate and fluent.
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
Hämta pristabeller för mallar
Ta emot en lista med pristabellobjekt för en specifik mall.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Mall-id
|
templateId | True | string |
Mall-id |
Returer
Pristabeller
- Pricing
- PricingTables
Ladda ned dokument
Dokumentfilen kan alltid laddas ned, men troligtvis vill du ladda ned den när den har statusen Signerad.
Du kan välja att ta emot en nedladdnings-URL eller hämta den binära filen.
Nedladdnings-URL:en kan nås 10 minuter efter att en begäran har gjorts.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
|
Returnera den binära filen direkt
|
direct | string |
Returnera den binära filen direkt |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
fil
|
file | string |
Ladda upp en bifogad fil
Du kan ladda upp bifogade filer som ska inkluderas med dokument som du skickar. En lyckad begäran returnerar attachment_id. Använd attachment_id för att tilldela en bifogad fil till ett dokument.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Filinnehåll
|
file_content | string |
Skicka filen som base64-kodad. Observera att base64-kodningsfiler ökar filstorleken med cirka 30% |
|
|
Filnamn
|
file_name | string |
Filnamn för dokumentet med tillägget. Det här är användbart när du konverterar olika filtyper. |
|
|
Fil-URL
|
file_url | string |
Url till dokumentfil. Filen måste vara tillgänglig för nedladdning utan auktorisering |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Filnamn
|
filename | string |
Filnamn för den bifogade filen |
|
ID för bifogad fil
|
id | string |
ID för den uppladdade bifogade filen som ska användas i attachment_id när du skapar ett dokument |
|
Rubrik för bifogad fil
|
title | string |
Rubrik på den bifogade filen |
|
Typ av bifogad fil
|
type | string |
Typ av bifogad fil |
Ladda upp en dokumentfil
Du kan ladda upp en fil i taget och hämta ett fil-ID. Fil-ID:t används för att ansluta en fil med ett GetAccept-dokument som skickas till mottagarna. Om du vill ladda upp mutliple-filer kör du flera POST. Vi accepterar endast filer upp till 10 MB som standard. Den uppladdade filen måste importeras/läggas till i ett dokument inom 48 timmar efter uppladdningen.
Vi rekommenderar att du laddar upp PDF-filer för att garantera samma utseende när de skickas. Andra filtyper kan konverteras, till exempel:
Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Filinnehåll
|
file_content | string |
Skicka filen som base64-kodad. Observera att base64-kodningsfiler ökar filstorleken med cirka 30% |
|
|
Filnamn
|
file_name | string |
Filnamn för dokumentet med tillägget. Det här är användbart när du konverterar olika filtyper. |
|
|
Fil-URL
|
file_url | string |
Url till dokumentfil. Filen måste vara tillgänglig för nedladdning utan auktorisering |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
file_id
|
file_id | string |
ID för den uppladdade fil som ska användas i file_ids när du skapar ett dokument |
|
file_status
|
file_status | string |
Status för den uppladdade filen |
Ladda upp en video
Du kan ladda upp bifogade filer som ska inkluderas med dokument som du skickar. En lyckad begäran returnerar attachment_id. Använd attachment_id för att tilldela en bifogad fil till ett dokument.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Filinnehåll
|
file_content | string |
Skicka filen som base64-kodad. Observera att base64-kodningsfiler ökar filstorleken med cirka 30% |
|
|
Filnamn
|
file_name | string |
Filnamn för dokumentet med tillägget. Det här är användbart när du konverterar olika filtyper. |
|
|
Fil-URL
|
file_url | string |
Url till dokumentfil. Filen måste vara tillgänglig för nedladdning utan auktorisering |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Filstatus
|
file_status | string |
Videons status |
|
Filnamn
|
filename | string |
Videons filnamn |
|
Jobb-ID
|
job_id | string |
ID för bearbetningsjobbet som konverterar och komprimerar videon. Sök efter jobbstatusuppdateringar med hjälp av /video/jobb/<ID>. |
|
Video-ID
|
video_id | string |
ID för den uppladdade videon som ska användas i video_id när du skapar ett dokument |
Lista användare
Hämta en lista över aktiva användare för den aktuella autentiserade entiteten
Returer
Användarlista
- Users
- Users
Lista mallar
Ta emot en lista över tillgängliga dokumentmallar. Du kan lägga till nya mallar under avsnittet Mallar i GetAccept.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Visa alla
|
showall | string |
Visa alla mallar för entitet |
|
|
Mapp-ID
|
folder_id | string |
Visa mallar i en specifik mapp |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
skapad_tid
|
templates.created_at | string | |
|
external_editor_type
|
templates.external_editor_type | string | |
|
field_count
|
templates.field_count | integer | |
|
Id-nummer
|
templates.id | string | |
|
is_editable
|
templates.is_editable | boolean | |
|
is_private
|
templates.is_private | boolean | |
|
name
|
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 |
Skapa användare
Då skapas en ny kontakt i databasen för den aktuella entiteten
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
company_name
|
company_name | string |
Associerat företagsnamn |
|
|
company_number
|
company_number | string |
Associerat företagsnummer |
|
|
Mejladress
|
string |
Kontaktens e-postadress |
||
|
first_name
|
first_name | string |
Kontaktens förnamn |
|
|
fullname
|
fullname | string |
Använd för att ange fullständigt namn i stället för för-/efternamn |
|
|
last_name
|
last_name | string |
Kontaktens efternamn |
|
|
mobile
|
mobile | string |
Mobilnummer i internationellt format |
|
|
not
|
note | string |
Valfri intern anteckning för kontakt |
|
|
phone
|
phone | string |
Telefonnummer i internationellt format |
|
|
title
|
title | string |
Kontaktens titel, till exempel. VD, Försäljningschef |
Returer
En användare definieras av sin e-postadress och är ansluten till en eller flera entiteter.
Användarroller
Administratör:
- Visa alla dokument
- Redigera alla dokument
- Ändra entitetsinställningar, information och fakturering
- Lägga till nya användare i entiteten
- Tilldela entitetsroller
Föreståndare:
- Visa gruppdokument
- Redigera alla dokument
- Lägga till nya användare i entiteten
Enhet
En entitet är den översta noden och alla användare och motsvarande dokument är anslutna till en entitet. En entitet är ofta densamma som ett företag, ett land eller en avdelning i en stor organisation.
- User
- User
Skapa kontakt
Då skapas en ny kontakt i databasen för den aktuella entiteten
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Företagsnamn
|
company_name | string |
Associerat företagsnamn |
|
|
Företagsnummer
|
company_number | string |
Associerat företagsnummer |
|
|
E-postmeddelande
|
string |
Kontaktens e-postadress |
||
|
Förnamn
|
first_name | string |
Kontaktens förnamn |
|
|
Fullständigt namn
|
fullname | string |
Använd för att ange fullständigt namn i stället för för-/efternamn |
|
|
Efternamn
|
last_name | string |
Kontaktens efternamn |
|
|
Mobil
|
mobile | string |
Mobilnummer i internationellt format |
|
|
Anmärkning
|
note | string |
Valfri intern anteckning för kontakt |
|
|
Telefon
|
phone | string |
Telefonnummer i internationellt format |
|
|
Titel
|
title | string |
Kontaktens titel, till exempel. VD, Försäljningschef |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kontakt-ID
|
contact_id | string |
ID för den skapade kontakten |
Skapa och skicka dokument eller mall
Du måste skapa ett dokument för att kunna skicka det till en mottagare. När du skapar ett dokument kan du referera till tidigare uppladdade filer med file_id eller så kan du välja att skapa ett dokument och ladda upp filerna i ett API-inlägg. Du kan bara ladda upp en fil när du inkluderar en fil i skapa dokumentet POST.
Använd antingen file_ids parameter för att använda befintliga uppladdade filer, file_content för att skicka dokumentet som base64-kodad sträng eller göra ett inlägg med flera delar med filparametern.
Alla mottagare måste ha antingen ett giltigt e-postmeddelande eller ett mobilnummer.
Alla händelser registreras med ip-adressen för beställaren. Du kan åsidosätta detta med hjälp av rubrik CLIENT_IP som innehåller slutanvändarens offentliga IP-adress.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
ID-nummer
|
id | string |
Bifogad fil-ID som tagits emot från listan eller efter uppladdning |
|
|
Kräv vy
|
require_view | boolean |
Kräv att mottagaren visar den bifogade filen |
|
|
Typ
|
type | string |
fil eller extern där filen är en uppladdad fil och extern är en länk till en extern fil |
|
|
Fält-ID
|
id | string |
ID för anpassat mallfält |
|
|
Fältnamn
|
name | string |
Namn på anpassat mallfält |
|
|
Fältvärde
|
value | string |
Värde för anpassat mallfält |
|
|
Valuta
|
currency | string |
Valuta, till exempel SEK |
|
|
Lokal
|
locale | string |
Nationella inställningar, till exempel sv-SE |
|
|
Visningsnamn
|
display_name | string |
Visningsnamn för pristabellen |
|
|
Externt ID
|
external_id | string |
Externt ID som representerar sammanfattningsobjektet i ett system från tredje part |
|
|
Tabell-ID
|
id | string |
Tabell-ID |
|
|
Förberäknade summor
|
pre_calculated | boolean |
Om pristabellsummor ska beräknas i förväg |
|
|
Visningsnamn
|
display_name | string |
Visningsnamn för pristabellen |
|
|
ID-nummer
|
id | string |
Avsnitts-ID |
|
|
Rows
|
rows |
Matris med värdeobjekt med matris med column_id, värde |
||
|
Enabled
|
enabled | boolean |
Om avsnittsrabatt ska aktiveras |
|
|
Fast avgift
|
flat_fee | boolean |
Om avsnittet ska använda med flata avgiftsrabatter |
|
|
Rabattvärde
|
value | string |
Värdet för avsnittsrabatt |
|
|
Enabled
|
enabled | boolean |
Om avsnittspriset ska vara aktiverat |
|
|
Fast avgift
|
flat_fee | boolean |
Om avsnittet ska använda fast avgiftspris |
|
|
Prisvärde
|
value | string |
Värdet för avsnittspriset |
|
|
Enabled
|
enabled | boolean |
Om avsnittsskatt ska aktiveras |
|
|
Fast avgift
|
flat_fee | boolean |
Om avsnittet ska använda med hjälp av fast avgiftsskatt |
|
|
Skattevärde
|
value | string |
Värdet för avsnittsskatt |
|
|
Enabled
|
enabled | boolean |
Om pristabellrabatten ska vara aktiverad |
|
|
Fast avgift
|
flat_fee | boolean |
Om pristabellen ska använda med flata avgiftsrabatter |
|
|
Rabattvärde
|
value | string |
Värdet för sammanfattningsrabatt |
|
|
Enabled
|
enabled | boolean |
Om pristabellpriset ska vara aktiverat |
|
|
Fast avgift
|
flat_fee | boolean |
Om pristabellen ska använda med fast avgiftspris |
|
|
Prisvärde
|
value | string |
Värdet för sammanfattningspris |
|
|
Enabled
|
enabled | boolean |
Om tabellskatt för prissättning ska aktiveras |
|
|
Fast avgift
|
flat_fee | boolean |
Om pristabellen ska använda med fasta avgiftsskatter |
|
|
Värde
|
value | string |
Värdet för sammanfattningsskatt |
|
|
Förfallodatum
|
expiration_date | date-time |
Datum och tid när dokumentet ska upphöra att gälla |
|
|
Externt ID
|
external_id | string |
Externt system-ID för identifiering |
|
|
Filinnehåll
|
file_content | string |
Base64-kodat filinnehåll |
|
|
Fil-ID:t
|
file_ids | string |
Kommaavgränsade, unika fil-ID:ar som tas emot när filer laddas upp |
|
|
Filnamn
|
file_name | string |
Filnamn för dokumentet med tillägget. Det här är användbart när du konverterar olika filtyper. |
|
|
Fil-URL
|
file_url | string |
Url till dokumentfil. Dokument måste vara offentliga för nedladdning |
|
|
Skicka automatiskt
|
is_automatic_sending | boolean |
Om dokumentet ska skickas när det har skapats |
|
|
Skicka påminnelser
|
is_reminder_sending | boolean |
Ska automatiska påminnelser skickas |
|
|
Schemalägg sändning
|
is_scheduled_sending | boolean |
Ska sändningen schemaläggas för att skickas i framtiden |
|
|
Signera dokument
|
is_signing | boolean |
Ska dokumentet skickas för signering |
|
|
Handskriven signatur
|
is_signing_biometric | boolean |
Använda handskriven signatur |
|
|
Tillåt signaturöverföring
|
is_signing_forward | boolean |
Ska mottagarna kunna överföra signaturrättigheter |
|
|
Signera med initialer
|
is_signing_initials | boolean |
Signera dokument med mottagarens initialer |
|
|
Skicka SMS
|
is_sms_sending | boolean |
Ska dokumentet skickas till mottagarens mobil via text |
|
|
Dokumentnamn
|
name | True | string |
Ange ett namn på dokumentet |
|
Företagsnamn
|
company_name | string |
Mottagarens företagsnamn |
|
|
Företagsnummer
|
company_number | string |
Mottagarens företagsnummer |
|
|
E-postmeddelande
|
string |
Mottagarens e-postadress |
||
|
Förnamn
|
first_name | string |
Mottagarens förnamn |
|
|
Efternamn
|
last_name | string |
Mottagarens efternamn |
|
|
Mobil
|
mobile | string |
Mobiltelefon i internationellt format |
|
|
Anmärkning
|
note | string |
Ytterligare anteckning för en mottagare |
|
|
Signeringsordning
|
order_num | integer |
Om signeringsordningen är aktiverad |
|
|
Mottagartyp
|
role | string |
Typ av mottagare i dokumentet |
|
|
Mallroll
|
role_name | string |
Namnet på rollen i en mall |
|
|
Verifiera EID
|
verify_eid | boolean |
Verifiera med EID |
|
|
EID-typ
|
verify_eid_type | string |
EID-typ som ska användas för personlig verifiering |
|
|
Aktivera fråga
|
verify_qna | boolean |
Bör en fråga ställas |
|
|
Verifieringssvar
|
verify_qna_answer | string |
Svaret på frågan |
|
|
Fråga om öppen
|
verify_qna_open | boolean |
Bör frågan ställas innan du öppnar dokumentet |
|
|
Verifieringsfråga
|
verify_qna_question | string |
Fråga att ställa för verifiering |
|
|
Teckenfråga
|
verify_qna_sign | boolean |
Bör en fråga ställas innan du signerar |
|
|
Verifiera SMS
|
verify_sms | boolean |
Verifiera mottagaren via SMS |
|
|
Kontrollera ATT SMS är öppet
|
verify_sms_open | boolean |
Kontrollera ATT SMS är öppet |
|
|
Verifiera via SMS
|
verify_sms_sign | boolean |
Ska ett SMS verifiera mottagaren innan du signerar |
|
|
Schemalägg sändningsdatum
|
scheduled_sending_time | date-time |
Datum och tid då dokumentet ska skickas ut |
|
|
Åsidosättning av e-post för avsändare
|
sender_email | string |
Skicka från annan e-post än autentiserad användare |
|
|
Åsidosättning av avsändare
|
sender_id | string |
Skicka från en annan användare än autentiserad |
|
|
Mall-id
|
template_id | string |
Välj en mall som ska användas för sändningen |
|
|
Dokumenttyp
|
type | string |
Ange typ/kategori för dokumentet |
|
|
Dokumentvärde
|
value | integer |
Värde för avtal eller dokument |
|
|
Video-ID
|
video_id | string |
Välj en video som ska användas för sändningen |
Returer
Ett dokument är en eller flera uppladdade filer som ska skickas till en eller flera mottagare som skapats av en användare.
- Dokument
- Document
Skicka befintligt dokument
När du skickar ett dokument via GetAccept skickar vi ett e-postmeddelande till alla mottagare som var och en innehåller en unik, skyddad länk. Det här API-anropet utlöser åtgärden skicka dokument och kan endast utföras på dokument med document_status = utkast. Dokumentet skickas till mottagare som du angav när det skapades.
Om dokumentet har skapats med självsigneringsalternativet kommer det också att vara självsignerat av den autentiserade eller angivna användaren innan det skickas.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
|
sender_email
|
sender_email |
Använd det här alternativet om du vill ange avsändarens användare/ägare per e-postadress som ska användas för självsignering av dokumentet. |
||
|
sender_id
|
sender_id | string |
Använd det här alternativet om du vill ange avsändarens användare/ägare efter ID som ska användas för självsignering av dokumentet. |
Returer
Ett dokument är en eller flera uppladdade filer som ska skickas till en eller flera mottagare som skapats av en användare.
- Dokument
- Document
Visa en lista med videor
Ta emot en lista över tillgängliga videor på entiteten. Du kan lägga till nya videor i mobilappen eller i GetAccept.
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
Redigerbara
|
videos.editable | boolean | |
|
publicerad
|
videos.published | boolean | |
|
räddad
|
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 |
Visa en lista över bifogade filer
Ta emot en lista över tillgängliga bifogade filer. Du kan lägga till nya bifogade filer i GetAccept med hjälp av ett nytt dokument.
Returer
Lista över bifogade filer
- Attachments
- Attachments
Visa en lista över dokument
Hämta en lista över tillgängliga dokument
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Filtrera lista efter status
|
filter | string |
Filtrera lista efter status |
|
|
Sortera resultat
|
sort_by | string |
Sortera resultat |
|
|
Sorteringsordning för resultat
|
sort_order | string |
Sorteringsordning för resultat |
|
|
Inkludera dokument från gruppmedlemmar
|
showteam | boolean |
Inkludera dokument från gruppmedlemmar |
|
|
Ta med alla dokument från entiteten
|
showall | boolean |
Ta med alla dokument från entiteten |
|
|
Externt ID
|
external_id | string |
Ett externt ID är ett anpassat fält som kan innehålla en unik postidentifierare från ett system utanför GetAccept |
|
|
Offset
|
offset | number |
Startlista från post x till gräns |
|
|
Limit
|
limit | number |
Antal poster som ska listas |
Returer
Dokumentlista
- Föremål
- Documents
Visa en lista över kontakter
Ta emot en lista över tillgängliga kontakter för den aktuella entiteten. Alla kontakter som läggs till som mottagare sparas som en kontakt och är tillgängliga för senare användning på den entiteten.
Returer
Kontaktlista
- Kontakter
- Contacts
Utlösare
| När ett dokument har avvisats |
Utlöses när ett dokument har avvisats av någon av mottagarna |
| När ett dokument har granskats |
Utlöses när ett dokument har granskats av någon av mottagarna |
| När ett dokument har signerats |
Utlöses när ett dokument har signerats av alla signeringsparter |
| Prenumerera på dokumenthändelser |
Det här anropet skapar en ny prenumeration. Svaret kommer att omslutas i en matris även för ett enskilt objekt enligt REST-hookstandarder.
|
När ett dokument har avvisats
Utlöses när ett dokument har avvisats av någon av mottagarna
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Alla entitetsanvändare
|
global | boolean |
Om webhooken ska fånga händelser för alla entitetsanvändare. |
|
|
E-postfel
|
notification_email | string |
Om händelsen misslyckas skickar du ett meddelande till det här e-postmeddelandet i stället för avsändaren |
|
|
Nyttolast
|
payload | string |
Ytterligare nyttolastdata att publicera |
Returer
Webhook-nyttolast
- Webhook (på engelska)
- Webhook
När ett dokument har granskats
Utlöses när ett dokument har granskats av någon av mottagarna
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Alla entitetsanvändare
|
global | boolean |
Om webhooken ska fånga händelser för alla entitetsanvändare. |
|
|
E-postfel
|
notification_email | string |
Om händelsen misslyckas skickar du ett meddelande till det här e-postmeddelandet i stället för avsändaren |
|
|
Nyttolast
|
payload | string |
Ytterligare nyttolastdata att publicera |
Returer
Webhook-nyttolast
- Webhook (på engelska)
- Webhook
När ett dokument har signerats
Utlöses när ett dokument har signerats av alla signeringsparter
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Alla entitetsanvändare
|
global | boolean |
Om webhooken ska fånga händelser för alla entitetsanvändare. |
|
|
E-postfel
|
notification_email | string |
Om händelsen misslyckas skickar du ett meddelande till det här e-postmeddelandet i stället för avsändaren |
|
|
Nyttolast
|
payload | string |
Ytterligare nyttolastdata att publicera |
Returer
Webhook-nyttolast
- Webhook (på engelska)
- Webhook
Prenumerera på dokumenthändelser
Det här anropet skapar en ny prenumeration. Svaret kommer att omslutas i en matris även för ett enskilt objekt enligt REST-hookstandarder.
Evenemang
-
document.created– Dokumentet skapas -
document.sent– Dokumentet skickas -
document.viewed– Dokumentet skickas -
document.signed– Dokumentet är signerat -
document.approved– Dokumentet har godkänts -
document.expired– Dokumentet har upphört att gälla -
document.rejected– Dokumentet avvisas -
document.downloaded– Dokumentet laddas ned -
document.printed– Dokumentet skrivs ut -
document.forwarded– Dokumentet vidarebefordras -
document.partially_signed– Dokumentet har delvis signerats -
document.commented– Dokumentet kommenteras -
document.hardbounced– Dokumentet är hårt bounced -
document.imported– Dokumentet importeras
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Välj händelse
|
event | True | string |
Händelseutlösare |
|
Alla entitetsanvändare
|
global | boolean |
Om webhooken ska fånga händelser för alla entitetsanvändare. |
|
|
E-postfel
|
notification_email | string |
Om händelsen misslyckas skickar du ett meddelande till det här e-postmeddelandet i stället för avsändaren |
|
|
Nyttolast
|
payload | string |
Ytterligare nyttolastdata att publicera |
Returer
Webhook-nyttolast
- Webhook (på engelska)
- Webhook
Definitioner
Bilaga
Bifogat dokument
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Åtkomstmottagare
|
access_recipient_names | array of string |
Mottagare med åtkomst till den bifogade filen |
|
Description
|
attachment_description | string |
Beskrivning av den bifogade filen |
|
Ladda ned URL
|
attachment_download_url | string |
URL för att ladda ned den bifogade filen |
|
Filnamnstillägg
|
attachment_extension | string |
Filnamnstillägget för den bifogade filen |
|
Filnamn
|
attachment_filename | string |
Filnamn för den bifogade filen |
|
ID-nummer
|
attachment_id | string |
ID för den bifogade filen |
|
Förhandsgransknings-URL
|
attachment_preview_url | string |
Intern URL för att förhandsgranska den bifogade filen |
|
Titel
|
attachment_title | string |
Rubrik på den bifogade filen |
|
Typ
|
attachment_type | string |
Typ av bifogad fil |
|
URL
|
attachment_url | string |
Url för den bifogade filen |
|
Senaste vy
|
last_attachment_view | string |
Datum och tid då den bifogade filen senast visades |
|
Begränsad åtkomst
|
restrict_access | boolean |
Den bifogade filen har begränsad åtkomst |
Attachments
Lista över bifogade filer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
Kontakt
Varje unik e-postadress (eller mobilnummer) definieras som en kontakt.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Företags-ID
|
company_id | string |
Företags-ID |
|
Företagslogotyp
|
company_logo_url | string |
Företagslogotyp |
|
Företagsnamn
|
company_name | string |
Kontaktens företagsnamn |
|
Företagsnummer
|
company_number | string |
Kontaktens företagsnummer |
|
Kontakt-ID
|
contact_id | string |
Kontakt-ID |
|
Skapades
|
created_at | string |
Datum för den skapade kontakten |
|
Documents
|
document_count | number |
Antal dokument för en kontakt |
|
Kontakta e-post
|
string |
Namnet på det skapade dokumentet |
|
|
Förnamn
|
first_name | string |
Kontaktens förnamn |
|
Fullständigt namn
|
fullname | string |
Fullständigt namn på kontakten |
|
Kön
|
gender | string |
Mottagarens kön |
|
Efternamn
|
last_name | string |
Kontaktens efternamn |
|
Mobil
|
mobile | string |
Kontaktens mobilnummer |
|
Anmärkning
|
note | string |
Anteckning om kontakten |
|
Tum-URL
|
thumb_url | string |
Kontaktens tum-URL |
|
Titel
|
title | string |
Kontaktens titel |
Kontakter
Kontaktlista
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
Dokument
Ett dokument är en eller flera uppladdade filer som ska skickas till en eller flera mottagare som skapats av en användare.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Etiketter
|
tags | string |
Dokumenttaggar |
|
Automatisk chatttext
|
auto_comment_text | string |
Automatisk chatttext |
|
Företagsnamn
|
company_name | string |
Företagsnamn |
|
Skapat vid
|
created_at | string |
När dokumentet skapades |
|
Ladda ned URL
|
download_url | string |
URL för att ladda ned signerat dokument |
|
E-postmeddelande
|
email_send_message | string |
Skicka e-postmeddelande |
|
E-postämne
|
email_send_subject | string |
Ämnestext för e-post |
|
Förfallodatum
|
expiration_date | string |
Förfallodatum för dokument |
|
Externt klient-ID
|
external_client_id | string | |
|
Externt redigerings-ID
|
external_editor_id | string |
ID i extern redigerare |
|
Typ av extern redigerare
|
external_editor_type | string | |
|
Externt ID
|
external_id | string | |
|
Antal fält
|
field_count | integer |
Antal fält i dokumentet |
|
ID-nummer
|
id | string | |
|
Automatisk kommentar
|
is_auto_comment | boolean |
Om automatisk chattkommentering är aktiverad |
|
E-post för automatisk kommentar
|
is_auto_comment_email | boolean |
Om automatisk chatt-e-post är aktiverad |
|
Identifiera mottagare
|
is_identify_recipient | boolean |
Om dokumentet har identifierat att mottagaren är aktiverad |
|
Är privat
|
is_private | boolean |
Om dokumentet är privat |
|
Skicka påminnelser
|
is_reminder_sending | boolean |
Om automatiska påminnelser är aktiverade |
|
Schemalagd sändning
|
is_scheduled_sending | boolean |
Om dokumentet har schemalagd sändning |
|
Självsignering
|
is_selfsign | boolean |
Om dokumentet har självsignerats av avsändaren |
|
Är signerad
|
is_signed | boolean |
Om dokumentet har signerats |
|
Signerbart dokument
|
is_signing | boolean |
Om dokumentet kan signeras |
|
Handskriven signatur
|
is_signing_biometric | boolean |
Om handskriven signatur är aktiverad |
|
Tillåt signaturöverföring
|
is_signing_forward | boolean |
Om överföring av signeringsrättigheter är aktiverad |
|
Signaturordning
|
is_signing_order | boolean |
Om mottagarsigneringsordningen är aktiverad |
|
Har video
|
is_video | boolean |
Om dokumentet har en introduktionsvideo |
|
Namn
|
name | string |
Namn på dokument |
|
Överordnat ID
|
parent_id | string |
ID för tidigare dokumentversion |
|
Förhandsgransknings-URL
|
preview_url | string |
Länk till intern förhandsgranskning av dokument |
|
recipients
|
recipients | array of Recipient | |
|
Schemalagd sändningstid
|
scheduled_sending_time | string |
När dokumentet skulle skickas |
|
Sändningsdatum
|
send_date | string |
Datum för dokumentsändning |
|
E-post för avsändare
|
sender_email | string |
E-postadress till avsändarens användare |
|
Avsändarens namn
|
sender_name | string |
Namn på avsändarens användare |
|
Avsändarens tum-URL
|
sender_thumb_url | string |
Tumbild av avsändarens användare |
|
Signeringsdatum
|
sign_date | string |
Datum för dokumentsignament |
|
Läge
|
status | string |
Aktuell status för dokumentet |
|
Tum-URL
|
thumb_url | string |
Tumbild av dokument |
|
Typ
|
type | string |
Dokumenttyp |
|
Unikt ID
|
unique_id | integer |
Unikt ID för dokument |
|
Användar-ID
|
user_id | string |
ID för avsändarens användare |
|
Värde
|
value | integer |
Dokumentvärde |
Documents
Dokumentlista
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
skapad_tid
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
Id-nummer
|
id | string | |
|
is_private
|
is_private | boolean | |
|
is_signing
|
is_signing | boolean | |
|
name
|
name | string | |
|
sender_name
|
sender_name | string | |
|
sender_thumb
|
sender_thumb | string | |
|
status
|
status | string | |
|
type
|
type | string | |
|
värde
|
value | integer |
EditorField
Information om redigeringsfält
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | string |
ID-nummer |
|
Etikett
|
input_settings.label | string |
Etikett |
|
Options
|
input_settings.options | array of string |
Options |
|
Krävs
|
input_settings.required | boolean |
Krävs |
|
Typ
|
input_settings.type | string |
Typ |
|
Mottagar-ID
|
recipient_id | string |
Mottagar-ID |
|
Typ
|
type | string |
Typ |
|
Användar-ID
|
user_id | string |
Användar-ID |
Fält
Fältinformation
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Företagsnamn
|
company_name | string |
Företagsnamn |
|
Företagsnummer
|
company_number | string |
Företagsnummer |
|
Fält-ID
|
field_id | string |
Fält-ID |
|
Etikett
|
field_label | string |
Etikett |
|
Options
|
field_options | array of object |
Options |
|
Värde
|
field_options.value | string | |
|
Typ
|
field_type | string |
Typ |
|
Värde
|
field_value | string |
Värde |
|
is_collectable
|
is_collectable | boolean |
Samlar in fält |
|
is_editable
|
is_editable | boolean |
Redigerbart fält |
|
is_required
|
is_required | boolean |
Obligatoriskt fält |
|
Sid-ID
|
page_id | string |
Sid-ID |
|
Mottagar-ID
|
recipient_id | string |
Mottagar-ID |
|
Mottagarnamn
|
recipient_name | string |
Mottagarnamn |
|
Rollnamn
|
role_name | string |
Rollnamn |
Fields
Fältlista
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
Fält
|
fields | array of Field |
PricingColumn
Pristabellkolumn
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
column_id | string |
ID-nummer |
|
Visningsnamn
|
display_name | string |
Visningsnamn |
|
Enabled
|
enabled | boolean |
Enabled |
|
Namn
|
name | string |
Namn |
PricingSection
Avsnittet Pristabell
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Visningsnamn
|
display_name | string |
Visningsnamn |
|
Namn
|
name | string |
Namn |
|
ID-nummer
|
section_id | string |
ID-nummer |
PricingTable
Pristabell
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Valuta
|
currency_settings.currency | string |
Valuta |
|
Lokal
|
currency_settings.locale | string |
Lokal |
|
Förberäknade summor
|
pre_calculated | boolean |
Förberäknade summor |
|
sektioner
|
sections | array of PricingSection | |
|
ID-nummer
|
table_id | string |
Tabell-ID |
PricingTables
Pristabeller
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
Varje unik e-postadress (eller mobilnummer) som är ansluten till ett dokument är en mottagare.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Företagsnamn
|
company_name | string |
Mottagarens företagsnamn |
|
Företagsnummer
|
company_number | string |
Mottagarens företagsnummer |
|
Dokument-URL
|
document_url | string |
Unik URL för mottagaren att visa/signera |
|
E-postmottagare
|
string |
Mottagarens e-post |
|
|
Förnamn
|
first_name | string |
Mottagarens förnamn |
|
Fullständigt namn
|
fullname | string |
Mottagarens fullständiga namn |
|
Kön
|
gender | string |
Mottagarens kön |
|
ID-nummer
|
id | string |
Mottagarens ID |
|
Efternamn
|
last_name | string |
Mottagarens efternamn |
|
Mobil
|
mobile | string |
Mottagarens mobilnummer |
|
Anmärkning
|
note | string |
Meddelande om mottagaren |
|
Signeringsordernummer
|
order_num | string |
Mottagarens signeringsordning |
|
Läge
|
status | string |
Mottagarens status |
|
Tum-URL
|
thumb_url | string |
Mottagarens tum-URL |
|
Titel
|
title | string |
Mottagarens titel |
Mottagare
Mottagarlista
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient |
User
En användare definieras av sin e-postadress och är ansluten till en eller flera entiteter.
Användarroller
Administratör:
- Visa alla dokument
- Redigera alla dokument
- Ändra entitetsinställningar, information och fakturering
- Lägga till nya användare i entiteten
- Tilldela entitetsroller
Föreståndare:
- Visa gruppdokument
- Redigera alla dokument
- Lägga till nya användare i entiteten
Enhet
En entitet är den översta noden och alla användare och motsvarande dokument är anslutna till en entitet. En entitet är ofta densamma som ett företag, ett land eller en avdelning i en stor organisation.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Appläge
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
E-postmeddelande
|
string |
Användarens e-postadress |
|
|
Enhetens ID
|
entity_id | string | |
|
Entitetsnamn
|
entity_name | string | |
|
Förnamn
|
first_name | string |
Användarens förnamn |
|
ID-nummer
|
id | string |
Användarens ID |
|
Language
|
language | string | |
|
Efternamn
|
last_name | string |
Användarens efternamn |
|
mobile
|
mobile | string |
Mobilnummer i internationellt format |
|
Anmärkning
|
note | string |
Valfri intern anteckning för användare |
|
Telefon
|
phone | string |
Telefonnummer i internationellt format |
|
Role
|
role | string | |
|
Hoppa över att skicka inbjudan
|
skip_invitation | boolean | |
|
Läge
|
status | string | |
|
Team-ID
|
team_id | string | |
|
Tum-URL
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Titel
|
title | string |
Användarens rubrik, till exempel. VD, Försäljningschef |
Users
Användarlista
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
users
|
users | array of object | |
|
E-postmeddelande
|
users.email | string | |
|
Förnamn
|
users.first_name | string | |
|
Senaste inloggning
|
users.last_login | string | |
|
Efternamn
|
users.last_name | string | |
|
Användarnamn
|
users.name | string | |
|
Role
|
users.role | string | |
|
Läge
|
users.status | string | |
|
Gruppnamn
|
users.team_name | string | |
|
Användar-ID
|
users.user_id | string |
Webhook (på engelska)
Webhook-nyttolast
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Anpassade fält
|
custom_fields | object | |
|
Dokument
|
document | Document |
Ett dokument är en eller flera uppladdade filer som ska skickas till en eller flera mottagare som skapats av en användare. |
|
Anpassad entitetsdomän
|
entity.custom_domain | string |
Anpassad domäninställning för entitet |
|
Standardmeddelande för e-post
|
entity.email_send_message | string |
Standardmeddelande för e-post |
|
Standardämne för e-post
|
entity.email_send_subject | string |
Standardämne för e-post |
|
Entitetsunderdomän
|
entity.sub_domain | string |
Underdomän för entiteten |
|
Händelsenamn
|
event | string | |
|
Händelseåtgärd
|
event_action | string | |
|
Händelsetyp
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
Varje unik e-postadress (eller mobilnummer) som är ansluten till ett dokument är en mottagare. |
|
Prenumerations-ID
|
subscription_id | string |