GetAccept
GetAccept poskytuje platformu pro podporu prodeje pro navrhování, odesílání, propagaci, sledování a elektronické podpisy prodejních dokumentů, využívání prodejních zajištění, řízení smluv, návrhů a elektronických podpisů na jednom místě.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Tým rozhraní API GetAccept |
| URL | https://app.getaccept.com/api |
| integrations@getaccept.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | GetAccept, Inc. |
| Internetová stránka | https://www.getaccept.com |
| Zásady ochrany osobních údajů | https://www.getaccept.com/privacy-policy |
| Kategorie | Prodej a CRM; Produktivita |
GetAccept poskytuje platformu pro podporu prodeje pro navrhování, odesílání, propagaci, sledování a elektronické podpisy prodejních dokumentů, využívání prodejních zajištění, řízení smluv, návrhů a elektronických podpisů na jednom místě. Tento konektor pomáhá automatizovat pracovní postupy pro ukládání dokumentů, načítání, přiřazení úkolů a přizpůsobená oznámení.
Požadavky
K použití tohoto připojení se vyžaduje účet GetAccept. Přejděte na getaccept.com a zaregistrujte si bezplatný účet.
Jak získat přihlašovací údaje?
K ověření aktuálního přihlášeného uživatele v GetAcceptu se vyžaduje jenom platný účet GetAccept, protože OAuth2 se používá k ověření aktuálního přihlášeného uživatele.
Známé problémy a omezení
V případě jakýchkoli problémů souvisejících s integrací se obraťte na naši [mailto:support@getaccept.com](technická podpora).
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Aktualizace vypršení platnosti dokumentu |
Tato metoda slouží k aktualizaci data a času vypršení platnosti dokumentu. |
| Nahrání přílohy |
Můžete nahrát soubory příloh, které chcete zahrnout do dokumentů, které odesíláte. Úspěšný požadavek vrátí attachment_id. K přiřazení přílohy k dokumentu použijte attachment_id. |
| Nahrání souboru dokumentu |
Najednou můžete nahrát jeden soubor a získat ID souboru. ID souboru slouží k připojení souboru k dokumentu GetAccept, který se odesílá příjemcům. Pokud chcete nahrát ztlumené soubory, spusťte více post. Jako výchozí přijímáme pouze soubory o velikosti 10 MB. Nahraný soubor je potřeba importovat nebo přidat do dokumentu do 48 hodin po nahrání. Doporučujeme vám nahrát soubory PDF, abyste zajistili stejný vzhled při odeslání. Jiné typy souborů lze převést, například: Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: čísla, klíčové obrázky: jpg, jpeg, png Jiné: html, tex, csv |
| Nahrání videa |
Můžete nahrát soubory příloh, které chcete zahrnout do dokumentů, které odesíláte. Úspěšný požadavek vrátí attachment_id. K přiřazení přílohy k dokumentu použijte attachment_id. |
| Odeslat existující dokument |
Když odešlete dokument přes GetAccept, doručíme všem příjemcům e-mail obsahující jedinečný zabezpečený odkaz. Toto volání rozhraní API aktivuje akci odeslání dokumentu a dá se provést pouze u dokumentů s document_status = koncept. Dokument se odešle příjemcům, které jste zadali při jeho vytvoření. Pokud byl dokument vytvořen pomocí možnosti samoobslužného podpisu, před odesláním bude také podepsaný svým držitelem ověřeným nebo zadaným uživatelem. |
| Stáhnout dokument |
Soubor dokumentu je možné kdykoli stáhnout, ale s největší pravděpodobností ho budete chtít stáhnout, pokud má stav Podepsáno. Můžete vybrat, jestli chcete získat adresu URL pro stažení nebo získat binární soubor. Adresa URL pro stažení je přístupná 10 minut po provedení požadavku. |
| Vytvoření a odeslání dokumentu nebo šablony |
Abyste ho mohli poslat příjemci, musíte vytvořit dokument. Při vytváření dokumentu můžete odkazovat na dříve nahrané soubory pomocí file_id nebo můžete zvolit vytvoření dokumentu a nahrání souborů do příspěvku rozhraní API. Soubor POST pro vytvoření můžete nahrát pouze při zahrnutí souboru do dokumentu POST. Pomocí parametru file_ids použijte existující nahrané soubory, file_content odeslat dokument jako řetězec kódovaný v base64, nebo provést vícedílný příspěvek s parametrem souboru. Všichni příjemci musí mít platný e-mail nebo číslo mobilního zařízení. Všechny události se zaznamenávají pomocí IP adresy žadatele. Můžete to přepsat pomocí hlavičky CLIENT_IP obsahující veřejnou IP adresu koncových uživatelů. |
| Vytvoření uživatele |
Tím se vytvoří nový kontakt v databázi pro aktuální entitu. |
| Vytvoří kontakt. |
Tím se vytvoří nový kontakt v databázi pro aktuální entitu. |
| Výpis dokumentů |
Získání seznamu dostupných dokumentů |
| Výpis kontaktů |
Obdrží seznam dostupných kontaktů pro aktuální entitu. Všechny kontakty přidané jako příjemce se uloží jako kontakt a jsou k dispozici pro pozdější použití v dané entitě. |
| Výpis příloh |
Zobrazí se seznam dostupných příloh. Nové přílohy v aplikaci GetAccept můžete přidat pomocí nového dokumentu. |
| Výpis šablon |
Získejte seznam dostupných šablon dokumentů. Nové šablony můžete přidat v části Šablony v getAcceptu. |
| Zobrazení seznamu uživatelů |
Načtení seznamu aktivních uživatelů pro aktuální ověřenou entitu |
| Zobrazení seznamu videí |
Získejte seznam dostupných videí o entitě. Do mobilní aplikace nebo do aplikace GetAccept můžete přidat nová videa. |
| Získání cenových tabulek šablon |
Získejte seznam položek s cenovou tabulkou pro konkrétní šablonu. |
| Získání podrobností o dokumentu |
Podrobnosti o dokumentu získáte zadáním ID dokumentu. |
| Získání podrobností o uživateli |
Toto volání vrátí podrobnosti o jednom uživateli. Příjem podrobností a dostupných entit aktuálního ověřeného uživatele pomocí id uživatele |
| Získání polí dokumentu |
Získejte seznam polí pro dokument nebo šablonu. Lze použít před i po podepsání dokumentu. |
| Získání polí šablony |
Obdrží seznam polí pro určitou šablonu. |
| Získání příjemců dokumentu |
Získejte seznam příjemců pro konkrétní dokument. |
| Získání příloh dokumentů |
Získejte přílohy dokumentu zadáním ID dokumentu. |
| Získání rolí šablon |
Získejte seznam rolí pro konkrétní šablonu. |
Aktualizace vypršení platnosti dokumentu
Tato metoda slouží k aktualizaci data a času vypršení platnosti dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
|
Datum vypršení platnosti
|
expiration_date | date-time |
Datum a čas vypršení platnosti dokumentu (UTC) |
|
|
Odeslat oznámení
|
send_notification | boolean |
Mělo by být příjemcům odesláno oznámení o aktualizaci. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stav
|
status | integer |
Stav aktualizace |
Nahrání přílohy
Můžete nahrát soubory příloh, které chcete zahrnout do dokumentů, které odesíláte. Úspěšný požadavek vrátí attachment_id. K přiřazení přílohy k dokumentu použijte attachment_id.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah souboru
|
file_content | string |
Odešlete soubor jako kódovaný jako base64. Všimněte si, že soubory kódování base64 zvětší velikost souboru o přibližně 30% |
|
|
Název souboru
|
file_name | string |
Název souboru dokumentu s příponou To bude užitečné při převodu různých typů souborů. |
|
|
Adresa URL souboru
|
file_url | string |
Adresa URL k souboru dokumentu Soubor musí být k dispozici ke stažení bez jakékoli autorizace. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název souboru
|
filename | string |
Název souboru přílohy |
|
ID přílohy
|
id | string |
ID nahrané přílohy, která se má použít v attachment_id při vytváření dokumentu |
|
Název přílohy
|
title | string |
Název přílohy |
|
Typ přílohy
|
type | string |
Typ přílohy |
Nahrání souboru dokumentu
Najednou můžete nahrát jeden soubor a získat ID souboru. ID souboru slouží k připojení souboru k dokumentu GetAccept, který se odesílá příjemcům. Pokud chcete nahrát ztlumené soubory, spusťte více post. Jako výchozí přijímáme pouze soubory o velikosti 10 MB. Nahraný soubor je potřeba importovat nebo přidat do dokumentu do 48 hodin po nahrání.
Doporučujeme vám nahrát soubory PDF, abyste zajistili stejný vzhled při odeslání. Jiné typy souborů lze převést, například:
Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: čísla, klíčové obrázky: jpg, jpeg, png Jiné: html, tex, csv
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah souboru
|
file_content | string |
Odešlete soubor jako kódovaný jako base64. Všimněte si, že soubory kódování base64 zvětší velikost souboru o přibližně 30% |
|
|
Název souboru
|
file_name | string |
Název souboru dokumentu s příponou To bude užitečné při převodu různých typů souborů. |
|
|
Adresa URL souboru
|
file_url | string |
Adresa URL k souboru dokumentu Soubor musí být k dispozici ke stažení bez jakékoli autorizace. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID souboru
|
file_id | string |
ID nahraného souboru, který se má použít v file_ids při vytváření dokumentu |
|
file_status
|
file_status | string |
Stav nahraného souboru |
Nahrání videa
Můžete nahrát soubory příloh, které chcete zahrnout do dokumentů, které odesíláte. Úspěšný požadavek vrátí attachment_id. K přiřazení přílohy k dokumentu použijte attachment_id.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah souboru
|
file_content | string |
Odešlete soubor jako kódovaný jako base64. Všimněte si, že soubory kódování base64 zvětší velikost souboru o přibližně 30% |
|
|
Název souboru
|
file_name | string |
Název souboru dokumentu s příponou To bude užitečné při převodu různých typů souborů. |
|
|
Adresa URL souboru
|
file_url | string |
Adresa URL k souboru dokumentu Soubor musí být k dispozici ke stažení bez jakékoli autorizace. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stav souboru
|
file_status | string |
Stav videa |
|
Název souboru
|
filename | string |
Název souboru videa |
|
ID úlohy
|
job_id | string |
ID úlohy zpracování, která převádí a komprimuje video. Dotazování na aktualizace stavu úlohy pomocí /video/job/<ID> |
|
ID videa
|
video_id | string |
ID nahraného videa, které se má použít v video_id při vytváření dokumentu |
Odeslat existující dokument
Když odešlete dokument přes GetAccept, doručíme všem příjemcům e-mail obsahující jedinečný zabezpečený odkaz. Toto volání rozhraní API aktivuje akci odeslání dokumentu a dá se provést pouze u dokumentů s document_status = koncept. Dokument se odešle příjemcům, které jste zadali při jeho vytvoření.
Pokud byl dokument vytvořen pomocí možnosti samoobslužného podpisu, před odesláním bude také podepsaný svým držitelem ověřeným nebo zadaným uživatelem.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
|
sender_email
|
sender_email |
Pomocí tohoto příkazu můžete zadat uživatele nebo vlastníka odesílatele podle e-mailové adresy, která se má použít k automatickému podepisování dokumentu. |
||
|
sender_id
|
sender_id | string |
Pomocí tohoto příkazu můžete určit uživatele nebo vlastníka odesílatele podle ID, které se má použít k automatickému podepisování dokumentu. |
Návraty
Dokument je jeden nebo více nahraných souborů, které se mají odeslat jednomu nebo mnoha příjemcům vytvořeným uživatelem.
- Dokument
- Document
Stáhnout dokument
Soubor dokumentu je možné kdykoli stáhnout, ale s největší pravděpodobností ho budete chtít stáhnout, pokud má stav Podepsáno.
Můžete vybrat, jestli chcete získat adresu URL pro stažení nebo získat binární soubor.
Adresa URL pro stažení je přístupná 10 minut po provedení požadavku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
|
Vrácení binárního souboru přímo
|
direct | string |
Vrácení binárního souboru přímo |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
soubor
|
file | string |
Vytvoření a odeslání dokumentu nebo šablony
Abyste ho mohli poslat příjemci, musíte vytvořit dokument. Při vytváření dokumentu můžete odkazovat na dříve nahrané soubory pomocí file_id nebo můžete zvolit vytvoření dokumentu a nahrání souborů do příspěvku rozhraní API. Soubor POST pro vytvoření můžete nahrát pouze při zahrnutí souboru do dokumentu POST.
Pomocí parametru file_ids použijte existující nahrané soubory, file_content odeslat dokument jako řetězec kódovaný v base64, nebo provést vícedílný příspěvek s parametrem souboru.
Všichni příjemci musí mít platný e-mail nebo číslo mobilního zařízení.
Všechny události se zaznamenávají pomocí IP adresy žadatele. Můžete to přepsat pomocí hlavičky CLIENT_IP obsahující veřejnou IP adresu koncových uživatelů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID
|
id | string |
ID přílohy přijaté ze seznamu nebo po nahrání |
|
|
Vyžadovat zobrazení
|
require_view | boolean |
Vyžadování zobrazení přílohy příjemcem |
|
|
Typ
|
type | string |
soubor nebo externí soubor, kde je nahraný soubor a externí je odkazem na externí soubor. |
|
|
ID pole
|
id | string |
ID pole vlastní šablony |
|
|
Název pole
|
name | string |
Název pole vlastní šablony |
|
|
Hodnota pole
|
value | string |
Hodnota pole vlastní šablony |
|
|
Měna
|
currency | string |
Měna, např. SEK |
|
|
Locale
|
locale | string |
Národní prostředí, např. sv-SE |
|
|
Zobrazovaný název
|
display_name | string |
Zobrazovaný název cenové tabulky |
|
|
Externí ID
|
external_id | string |
Externí ID představující souhrnný objekt v rámci systému třetí strany |
|
|
ID tabulky
|
id | string |
ID tabulky |
|
|
Předem vypočtené součty
|
pre_calculated | boolean |
Pokud by se měly předem vypočítat celkové hodnoty cenových tabulek |
|
|
Zobrazovaný název
|
display_name | string |
Zobrazovaný název cenové tabulky |
|
|
ID
|
id | string |
ID oddílu |
|
|
Řádky
|
rows |
Matice s objektem hodnot s polem column_id, hodnota |
||
|
Enabled
|
enabled | boolean |
Pokud by měla být povolená sleva za oddíl |
|
|
Poplatek za byt
|
flat_fee | boolean |
Pokud by oddíl měl používat slevy za ploché poplatky |
|
|
Discount Value
|
value | string |
Hodnota slevy za oddíl |
|
|
Enabled
|
enabled | boolean |
Pokud by měla být povolená cena oddílu |
|
|
Poplatek za byt
|
flat_fee | boolean |
Pokud by se v oddílu měly používat ceny plochých poplatků |
|
|
Cenová hodnota
|
value | string |
Hodnota pro cenu oddílu |
|
|
Enabled
|
enabled | boolean |
Pokud by se měla povolit daň oddílu |
|
|
Poplatek za byt
|
flat_fee | boolean |
Pokud by část měla používat daně z plochého poplatku |
|
|
Daňová hodnota
|
value | string |
Hodnota daně z oddílu |
|
|
Enabled
|
enabled | boolean |
Pokud by se měla povolit sleva za cenovou tabulku |
|
|
Poplatek za byt
|
flat_fee | boolean |
Pokud by cenová tabulka měla používat slevy za ploché poplatky |
|
|
Discount Value
|
value | string |
Hodnota souhrnné slevy |
|
|
Enabled
|
enabled | boolean |
Pokud by se měla povolit cenová cena tabulky |
|
|
Poplatek za byt
|
flat_fee | boolean |
Pokud by cenová tabulka měla používat ceny plochých poplatků |
|
|
Cenová hodnota
|
value | string |
Hodnota souhrnné ceny |
|
|
Enabled
|
enabled | boolean |
Pokud by se měla povolit daň z cenové tabulky |
|
|
Poplatek za byt
|
flat_fee | boolean |
Pokud by cenová tabulka měla používat daně z plochých poplatků |
|
|
Hodnota
|
value | string |
Hodnota souhrnné daně |
|
|
Datum vypršení platnosti
|
expiration_date | date-time |
Datum a čas vypršení platnosti dokumentu |
|
|
Externí ID
|
external_id | string |
ID externího systému pro identifikaci |
|
|
Obsah souboru
|
file_content | string |
Obsah souboru s kódováním Base64 |
|
|
ID souborů
|
file_ids | string |
Oddělené čárkami, jedinečné ID souborů přijaté při nahrávání souborů |
|
|
Název souboru
|
file_name | string |
Název souboru dokumentu s příponou To bude užitečné při převodu různých typů souborů. |
|
|
Adresa URL souboru
|
file_url | string |
Adresa URL k souboru dokumentu Dokumenty musí být veřejně dostupné ke stažení. |
|
|
Automatické odesílání
|
is_automatic_sending | boolean |
Pokud se má dokument odeslat po vytvoření |
|
|
Odeslání připomenutí
|
is_reminder_sending | boolean |
Měla by se odesílat automatická připomenutí. |
|
|
Naplánování odesílání
|
is_scheduled_sending | boolean |
Mělo by být odesílání naplánováno pro odeslání v budoucnu. |
|
|
Podepsat dokument
|
is_signing | boolean |
Má se dokument odeslat k podepsání. |
|
|
Ručně psaný podpis
|
is_signing_biometric | boolean |
Použití rukou psaného podpisu |
|
|
Povolit přenos podpisu
|
is_signing_forward | boolean |
Pokud mají příjemci možnost přenést podpisová práva |
|
|
Sign with initials
|
is_signing_initials | boolean |
Podepsání dokumentu pomocí iniciály příjemců |
|
|
Odeslat SMS
|
is_sms_sending | boolean |
Pokud se dokument odešle příjemci na mobil textem |
|
|
Název dokumentu
|
name | True | string |
Zadejte název dokumentu. |
|
Název společnosti
|
company_name | string |
Název společnosti příjemce |
|
|
Číslo společnosti
|
company_number | string |
Číslo společnosti příjemce |
|
|
Email
|
string |
E-mailová adresa příjemce |
||
|
Křestní jméno
|
first_name | string |
Jméno příjemce |
|
|
Příjmení
|
last_name | string |
Příjmení příjemce |
|
|
Mobilní zařízení
|
mobile | string |
Mobilní telefon v mezinárodním formátu |
|
|
Poznámka:
|
note | string |
Další poznámka pro příjemce |
|
|
Podpisová objednávka
|
order_num | integer |
Pokud je povolená podpisová objednávka |
|
|
Typ příjemce
|
role | string |
Druh příjemce v dokumentu |
|
|
Role šablony
|
role_name | string |
Název role v šabloně |
|
|
Ověření EID
|
verify_eid | boolean |
Ověření pomocí EID |
|
|
Typ EID
|
verify_eid_type | string |
Typ EID, který se má použít pro osobní ověření |
|
|
Povolit otázku
|
verify_qna | boolean |
Měla by se položit otázka. |
|
|
Odpověď na ověření
|
verify_qna_answer | string |
Odpověď na otázku |
|
|
Otázka při otevření
|
verify_qna_open | boolean |
Měla by se před otevřením dokumentu položit otázka. |
|
|
Otázka ověření
|
verify_qna_question | string |
Otázka, která se má požádat o ověření |
|
|
Otázka podepisovat
|
verify_qna_sign | boolean |
Měla by se před podepsáním položit otázka. |
|
|
Ověření SMS
|
verify_sms | boolean |
Ověření příjemce sms |
|
|
Ověření sms při otevření
|
verify_sms_open | boolean |
Ověření sms při otevření |
|
|
Ověření sms
|
verify_sms_sign | boolean |
Pokud zpráva SMS před podepsáním příjemce ověří příjemce |
|
|
Datum odeslání plánu
|
scheduled_sending_time | date-time |
Datum a čas odeslání dokumentu |
|
|
Přepsání e-mailu odesílatele
|
sender_email | string |
Odeslání z jiného e-mailu než ověřeného uživatele |
|
|
Přepsání uživatele odesílatele
|
sender_id | string |
Odeslání od jiného uživatele, než je ověřené |
|
|
ID šablony
|
template_id | string |
Vyberte šablonu, která se má použít pro odesílání. |
|
|
Typ dokumentu
|
type | string |
Nastavení typu/kategorie dokumentu |
|
|
Hodnota dokumentu
|
value | integer |
Hodnota dohody nebo dokumentu |
|
|
ID videa
|
video_id | string |
Vyberte video, které se má použít pro odesílání. |
Návraty
Dokument je jeden nebo více nahraných souborů, které se mají odeslat jednomu nebo mnoha příjemcům vytvořeným uživatelem.
- Dokument
- Document
Vytvoření uživatele
Tím se vytvoří nový kontakt v databázi pro aktuální entitu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
company_name
|
company_name | string |
Název přidružené společnosti |
|
|
company_number
|
company_number | string |
Přidružené číslo společnosti |
|
|
e-mail
|
string |
E-mailová adresa kontaktu |
||
|
first_name
|
first_name | string |
Jméno kontaktu |
|
|
fullname
|
fullname | string |
Slouží k zadání celého jména místo křestního jména nebo příjmení. |
|
|
last_name
|
last_name | string |
Příjmení kontaktu |
|
|
mobilní
|
mobile | string |
Číslo mobilního zařízení v mezinárodním formátu |
|
|
poznámka
|
note | string |
Volitelná interní poznámka pro kontakt |
|
|
telefon
|
phone | string |
Telefonní číslo v mezinárodním formátu |
|
|
title
|
title | string |
Název kontaktu, např. Generální ředitel, manažer prodeje |
Návraty
Uživatel je definovaný e-mailovou adresou a je připojený k jedné nebo mnoha entitě.
Role uživatelů
Správce:
- Zobrazit všechny dokumenty
- Upravit všechny dokumenty
- Změna nastavení entity, informací a fakturace
- Přidání nových uživatelů do entity
- Přiřazení rolí entit
Manažer:
- Zobrazení týmových dokumentů
- Upravit všechny dokumenty
- Přidání nových uživatelů do entity
Entita
Entita je nejvyšší uzel a všichni uživatelé a odpovídající dokumenty jsou připojené k entitě. Entita je často stejná jako společnost, země nebo oddělení ve velké organizaci.
- Uživatel
- User
Vytvoří kontakt.
Tím se vytvoří nový kontakt v databázi pro aktuální entitu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název společnosti
|
company_name | string |
Název přidružené společnosti |
|
|
Číslo společnosti
|
company_number | string |
Přidružené číslo společnosti |
|
|
Email
|
string |
E-mailová adresa kontaktu |
||
|
Křestní jméno
|
first_name | string |
Jméno kontaktu |
|
|
Jméno a příjmení
|
fullname | string |
Slouží k zadání celého jména místo křestního jména nebo příjmení. |
|
|
Příjmení
|
last_name | string |
Příjmení kontaktu |
|
|
Mobilní zařízení
|
mobile | string |
Číslo mobilního zařízení v mezinárodním formátu |
|
|
Poznámka:
|
note | string |
Volitelná interní poznámka pro kontakt |
|
|
telefon
|
phone | string |
Telefonní číslo v mezinárodním formátu |
|
|
Title
|
title | string |
Název kontaktu, např. Generální ředitel, manažer prodeje |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID kontaktu
|
contact_id | string |
ID vytvořeného kontaktu |
Výpis dokumentů
Získání seznamu dostupných dokumentů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Seznam filtrů podle stavu
|
filter | string |
Seznam filtrů podle stavu |
|
|
Řazení výsledků
|
sort_by | string |
Řazení výsledků |
|
|
Pořadí řazení výsledků
|
sort_order | string |
Pořadí řazení výsledků |
|
|
Zahrnutí dokumentů od členů týmu
|
showteam | boolean |
Zahrnutí dokumentů od členů týmu |
|
|
Zahrnout všechny dokumenty z entity
|
showall | boolean |
Zahrnout všechny dokumenty z entity |
|
|
Externí ID
|
external_id | string |
Externí ID je vlastní pole, které může obsahovat jedinečný identifikátor záznamu ze systému mimo GetAccept. |
|
|
Posun
|
offset | number |
Počáteční seznam ze záznamu x do limitu |
|
|
Omezení
|
limit | number |
Počet záznamů, které se mají vypsat |
Návraty
Seznam dokumentů
- Položky
- Documents
Výpis kontaktů
Obdrží seznam dostupných kontaktů pro aktuální entitu. Všechny kontakty přidané jako příjemce se uloží jako kontakt a jsou k dispozici pro pozdější použití v dané entitě.
Návraty
Seznam kontaktů
- Contacts
- Contacts
Výpis příloh
Zobrazí se seznam dostupných příloh. Nové přílohy v aplikaci GetAccept můžete přidat pomocí nového dokumentu.
Návraty
Seznam příloh
- Attachments
- Attachments
Výpis šablon
Získejte seznam dostupných šablon dokumentů. Nové šablony můžete přidat v části Šablony v getAcceptu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Zobrazit vše
|
showall | string |
Zobrazit všechny šablony pro entitu |
|
|
ID složky
|
folder_id | string |
Zobrazení šablon v konkrétní složce |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
datum_vytvoření
|
templates.created_at | string | |
|
external_editor_type
|
templates.external_editor_type | string | |
|
field_count
|
templates.field_count | integer | |
|
identifikační číslo
|
templates.id | string | |
|
is_editable
|
templates.is_editable | boolean | |
|
is_private
|
templates.is_private | boolean | |
|
název
|
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 | |
|
typ
|
templates.type | string | |
|
user_id
|
templates.user_id | string | |
|
video_id
|
templates.video_id | string | |
|
video_thumb_url
|
templates.video_thumb_url | string |
Zobrazení seznamu uživatelů
Načtení seznamu aktivních uživatelů pro aktuální ověřenou entitu
Návraty
Seznam uživatelů
- Uživatelé
- Users
Zobrazení seznamu videí
Získejte seznam dostupných videí o entitě. Do mobilní aplikace nebo do aplikace GetAccept můžete přidat nová videa.
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
upravitelný
|
videos.editable | boolean | |
|
publikovaný
|
videos.published | boolean | |
|
uložený
|
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 |
Získání cenových tabulek šablon
Získejte seznam položek s cenovou tabulkou pro konkrétní šablonu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID šablony
|
templateId | True | string |
ID šablony |
Návraty
Cenové tabulky
- Pricing
- PricingTables
Získání podrobností o dokumentu
Podrobnosti o dokumentu získáte zadáním ID dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
Návraty
Dokument je jeden nebo více nahraných souborů, které se mají odeslat jednomu nebo mnoha příjemcům vytvořeným uživatelem.
- Dokument
- Document
Získání podrobností o uživateli
Toto volání vrátí podrobnosti o jednom uživateli. Příjem podrobností a dostupných entit aktuálního ověřeného uživatele pomocí id uživatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID uživatele
|
userId | True | string |
ID uživatele |
Návraty
Uživatel je definovaný e-mailovou adresou a je připojený k jedné nebo mnoha entitě.
Role uživatelů
Správce:
- Zobrazit všechny dokumenty
- Upravit všechny dokumenty
- Změna nastavení entity, informací a fakturace
- Přidání nových uživatelů do entity
- Přiřazení rolí entit
Manažer:
- Zobrazení týmových dokumentů
- Upravit všechny dokumenty
- Přidání nových uživatelů do entity
Entita
Entita je nejvyšší uzel a všichni uživatelé a odpovídající dokumenty jsou připojené k entitě. Entita je často stejná jako společnost, země nebo oddělení ve velké organizaci.
- Uživatel
- User
Získání polí dokumentu
Získejte seznam polí pro dokument nebo šablonu. Lze použít před i po podepsání dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
Návraty
Seznam polí
- Fields
- Fields
Získání polí šablony
Obdrží seznam polí pro určitou šablonu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID šablony
|
templateId | True | string |
ID šablony |
Návraty
Seznam polí
- Fields
- Fields
Získání příjemců dokumentu
Získejte seznam příjemců pro konkrétní dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
Návraty
Seznam příjemců
- Příjemci
- Recipients
Získání příloh dokumentů
Získejte přílohy dokumentu zadáním ID dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
Návraty
Seznam příloh
- Attachments
- Attachments
Získání rolí šablon
Získejte seznam rolí pro konkrétní šablonu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID šablony
|
templateId | True | string |
ID šablony |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
e-mail
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
mobilní
|
roles.mobile | string | |
|
role
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
Aktivační události
| Po kontrole dokumentu |
Aktivuje se, když některý z příjemců zkontroluje dokument. |
| Po odmítnutí dokumentu |
Aktivuje se, když některý z příjemců odmítne dokument. |
| Po podepsání dokumentu |
Aktivuje se, když dokument podepsali všichni podpisové strany. |
| Přihlášení k odběru událostí dokumentu |
Toto volání vytvoří nové předplatné. Odpověď bude zabalena do pole i pro jeden objekt podle standardů REST hook.
|
Po kontrole dokumentu
Aktivuje se, když některý z příjemců zkontroluje dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Všichni uživatelé entit
|
global | boolean |
Pokud by webhook měl zachytit události pro všechny uživatele entity. |
|
|
E-mail s chybou
|
notification_email | string |
Pokud událost selže, pošlete místo odesílatele oznámení na tento e-mail. |
|
|
Užitečný náklad
|
payload | string |
Další data datové části, která se mají publikovat |
Návraty
Datová část Webhooku
- Webhook
- Webhook
Po odmítnutí dokumentu
Aktivuje se, když některý z příjemců odmítne dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Všichni uživatelé entit
|
global | boolean |
Pokud by webhook měl zachytit události pro všechny uživatele entity. |
|
|
E-mail s chybou
|
notification_email | string |
Pokud událost selže, pošlete místo odesílatele oznámení na tento e-mail. |
|
|
Užitečný náklad
|
payload | string |
Další data datové části, která se mají publikovat |
Návraty
Datová část Webhooku
- Webhook
- Webhook
Po podepsání dokumentu
Aktivuje se, když dokument podepsali všichni podpisové strany.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Všichni uživatelé entit
|
global | boolean |
Pokud by webhook měl zachytit události pro všechny uživatele entity. |
|
|
E-mail s chybou
|
notification_email | string |
Pokud událost selže, pošlete místo odesílatele oznámení na tento e-mail. |
|
|
Užitečný náklad
|
payload | string |
Další data datové části, která se mají publikovat |
Návraty
Datová část Webhooku
- Webhook
- Webhook
Přihlášení k odběru událostí dokumentu
Toto volání vytvoří nové předplatné. Odpověď bude zabalena do pole i pro jeden objekt podle standardů REST hook.
Events
-
document.created- Vytvoří se dokument. -
document.sent- Dokument se odešle. -
document.viewed- Dokument se odešle. -
document.signed- Dokument je podepsaný. -
document.approved- Dokument je schválen. -
document.expired– Platnost dokumentu vypršela. -
document.rejected- Dokument je odmítnut. -
document.downloaded- Dokument se stáhne. -
document.printed- Dokument se vytiskne. -
document.forwarded- Dokument je přeposlaný. -
document.partially_signed- Dokument byl částečně podepsán. -
document.commented- Dokument je okomentován. -
document.hardbounced- Dokument je pevně zatvrzen -
document.imported– Dokument se importuje.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Výběr události
|
event | True | string |
Aktivační událost |
|
Všichni uživatelé entit
|
global | boolean |
Pokud by webhook měl zachytit události pro všechny uživatele entity. |
|
|
E-mail s chybou
|
notification_email | string |
Pokud událost selže, pošlete místo odesílatele oznámení na tento e-mail. |
|
|
Užitečný náklad
|
payload | string |
Další data datové části, která se mají publikovat |
Návraty
Datová část Webhooku
- Webhook
- Webhook
Definice
Příloha
Příloha dokumentu
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Přístup k příjemcům
|
access_recipient_names | array of string |
Příjemci s přístupem k příloze |
|
Description
|
attachment_description | string |
Popis přílohy |
|
Adresa URL pro stažení
|
attachment_download_url | string |
Adresa URL pro stažení přílohy |
|
Přípona souboru
|
attachment_extension | string |
Přípona souboru přílohy |
|
Jméno souboru
|
attachment_filename | string |
Název souboru přílohy |
|
ID
|
attachment_id | string |
ID přílohy |
|
Náhled adresy URL
|
attachment_preview_url | string |
Interní adresa URL pro zobrazení náhledu přílohy |
|
Title
|
attachment_title | string |
Název přílohy |
|
Typ
|
attachment_type | string |
Typ přílohy |
|
URL
|
attachment_url | string |
Adresa URL přílohy |
|
Poslední zobrazení
|
last_attachment_view | string |
Datum a čas posledního zobrazení přílohy |
|
Omezený přístup
|
restrict_access | boolean |
Příloha má omezený přístup |
Attachments
Seznam příloh
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
Kontakt
Každá jedinečná e-mailová adresa (nebo mobilní číslo) je definována jako kontakt.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID společnosti
|
company_id | string |
ID společnosti |
|
Firemní značka
|
company_logo_url | string |
Firemní značka |
|
Název společnosti
|
company_name | string |
Název společnosti kontaktu |
|
Číslo společnosti
|
company_number | string |
Číslo společnosti kontaktu |
|
ID kontaktu
|
contact_id | string |
ID kontaktu |
|
Vytvořené
|
created_at | string |
Datum vytvoření kontaktu |
|
Documents
|
document_count | number |
Počet dokumentů kontaktu |
|
Kontaktní e-mail
|
string |
Název vytvořeného dokumentu |
|
|
Křestní jméno
|
first_name | string |
Jméno kontaktu |
|
Jméno a příjmení
|
fullname | string |
Celé jméno kontaktu |
|
Pohlaví
|
gender | string |
Pohlaví příjemce |
|
Příjmení
|
last_name | string |
Příjmení kontaktu |
|
Mobilní zařízení
|
mobile | string |
Číslo mobilního kontaktu |
|
Poznámka:
|
note | string |
Poznámka kontaktu |
|
Adresa URL palce
|
thumb_url | string |
Kryptografický adresa URL kontaktu |
|
Title
|
title | string |
Název kontaktu |
Contacts
Seznam kontaktů
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
Dokument
Dokument je jeden nebo více nahraných souborů, které se mají odeslat jednomu nebo mnoha příjemcům vytvořeným uživatelem.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Štítky
|
tags | string |
Značky dokumentů |
|
Automatický text chatu
|
auto_comment_text | string |
Automatický text chatu |
|
Název společnosti
|
company_name | string |
Název společnosti |
|
Vytvořeno v
|
created_at | string |
Po vytvoření dokumentu |
|
Adresa URL pro stažení
|
download_url | string |
Adresa URL pro stažení podepsaného dokumentu |
|
E-mailová zpráva
|
email_send_message | string |
Odesílání e-mailových zpráv |
|
Předmět e-mailu
|
email_send_subject | string |
Text předmětu e-mailu |
|
Datum vypršení platnosti
|
expiration_date | string |
Datum vypršení platnosti dokumentu |
|
ID externího klienta
|
external_client_id | string | |
|
ID externího editoru
|
external_editor_id | string |
ID v externím editoru |
|
Typ externího editoru
|
external_editor_type | string | |
|
Externí ID
|
external_id | string | |
|
Počet polí
|
field_count | integer |
Počet polí v dokumentu |
|
ID
|
id | string | |
|
Automatický komentář
|
is_auto_comment | boolean |
Pokud je povolený automatický komentář chatu |
|
E-mail s automatickým komentářem
|
is_auto_comment_email | boolean |
Pokud je povolený automatický chatovací e-mail |
|
Identifikace příjemce
|
is_identify_recipient | boolean |
Pokud je dokument s povolenou identifikací příjemce |
|
Je soukromý
|
is_private | boolean |
Pokud je dokument soukromý |
|
Odeslání připomenutí
|
is_reminder_sending | boolean |
Pokud jsou povolená automatická připomenutí |
|
Naplánované odesílání
|
is_scheduled_sending | boolean |
Pokud má dokument naplánované odesílání |
|
Samoobslužné podepisování
|
is_selfsign | boolean |
Pokud byl dokument podepsaný svým držitelem odesílatelem |
|
Je podepsáno
|
is_signed | boolean |
Pokud byl dokument podepsán |
|
Podepsatelný dokument
|
is_signing | boolean |
Pokud je dokument podepisovatelný |
|
Ručně psaný podpis
|
is_signing_biometric | boolean |
Pokud je povolený ručně psaný podpis |
|
Povolit přenos podpisu
|
is_signing_forward | boolean |
Pokud je povolen přenos podpisových práv |
|
Pořadí podpisu
|
is_signing_order | boolean |
Pokud je podpisová objednávka příjemce povolená |
|
Obsahuje video
|
is_video | boolean |
Pokud dokument obsahuje úvodní video |
|
Název
|
name | string |
Název dokumentu |
|
Nadřazené ID
|
parent_id | string |
ID předchozí verze dokumentu |
|
Náhled adresy URL
|
preview_url | string |
Odkaz na interní náhled dokumentu |
|
recipients
|
recipients | array of Recipient | |
|
Naplánovaný čas odeslání
|
scheduled_sending_time | string |
Kdy byl dokument naplánován k odeslání |
|
Datum odeslání
|
send_date | string |
Datum odeslání dokumentu |
|
E-mail odesílatele
|
sender_email | string |
E-mailová adresa uživatele odesílatele |
|
Jméno odesílatele
|
sender_name | string |
Jméno uživatele odesílatele |
|
Adresa URL palce odesílatele
|
sender_thumb_url | string |
Obrázek uživatele s palcem odesílatele |
|
Datum podpisu
|
sign_date | string |
Datum podpisu dokumentu |
|
Stav
|
status | string |
Aktuální stav dokumentu |
|
Adresa URL palce
|
thumb_url | string |
Palec obrázku dokumentu |
|
Typ
|
type | string |
Typ dokumentu |
|
Jedinečné ID
|
unique_id | integer |
Jedinečné ID dokumentu |
|
ID uživatele
|
user_id | string |
ID uživatele odesílatele |
|
Hodnota
|
value | integer |
Hodnota dokumentu |
Documents
Seznam dokumentů
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
datum_vytvoření
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
identifikační číslo
|
id | string | |
|
is_private
|
is_private | boolean | |
|
is_signing
|
is_signing | boolean | |
|
název
|
name | string | |
|
sender_name
|
sender_name | string | |
|
sender_thumb
|
sender_thumb | string | |
|
stav
|
status | string | |
|
typ
|
type | string | |
|
value
|
value | integer |
EditorField
Podrobnosti pole editoru
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID
|
id | string |
ID |
|
Označení
|
input_settings.label | string |
Označení |
|
Možnosti
|
input_settings.options | array of string |
Možnosti |
|
Povinné
|
input_settings.required | boolean |
Povinné |
|
Typ
|
input_settings.type | string |
Typ |
|
ID příjemce
|
recipient_id | string |
ID příjemce |
|
Typ
|
type | string |
Typ |
|
ID uživatele
|
user_id | string |
ID uživatele |
Obor
Podrobnosti o poli
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název společnosti
|
company_name | string |
Název společnosti |
|
Číslo společnosti
|
company_number | string |
Číslo společnosti |
|
ID pole
|
field_id | string |
ID pole |
|
Označení
|
field_label | string |
Označení |
|
Možnosti
|
field_options | array of object |
Možnosti |
|
Hodnota
|
field_options.value | string | |
|
Typ
|
field_type | string |
Typ |
|
Hodnota
|
field_value | string |
Hodnota |
|
is_collectable
|
is_collectable | boolean |
Pole shromažďování |
|
is_editable
|
is_editable | boolean |
Upravitelné pole |
|
is_required
|
is_required | boolean |
Povinné pole |
|
ID stránky
|
page_id | string |
ID stránky |
|
ID příjemce
|
recipient_id | string |
ID příjemce |
|
Jméno příjemce
|
recipient_name | string |
Jméno příjemce |
|
Název role
|
role_name | string |
Název role |
Fields
Seznam polí
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
pole
|
fields | array of Field |
Cenový sloupec
Sloupec tabulky s cenami
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID
|
column_id | string |
ID |
|
Zobrazovaný název
|
display_name | string |
Zobrazovaný název |
|
Enabled
|
enabled | boolean |
Enabled |
|
Název
|
name | string |
Název |
PricingSection
Oddíl s cenovou tabulkou
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Zobrazovaný název
|
display_name | string |
Zobrazovaný název |
|
Název
|
name | string |
Název |
|
ID
|
section_id | string |
ID |
Cenová tabulka
Cenová tabulka
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Měna
|
currency_settings.currency | string |
Měna |
|
Locale
|
currency_settings.locale | string |
Locale |
|
Předpočítané součty
|
pre_calculated | boolean |
Předpočítané součty |
|
sekce
|
sections | array of PricingSection | |
|
ID
|
table_id | string |
ID tabulky |
Cenové tabulky
Cenové tabulky
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
Každou jedinečnou e-mailovou adresu (nebo mobilní číslo), která je připojená k dokumentu, je příjemcem.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název společnosti
|
company_name | string |
Název společnosti příjemce |
|
Číslo společnosti
|
company_number | string |
Číslo společnosti příjemce |
|
Adresa URL dokumentu
|
document_url | string |
Jedinečná adresa URL příjemce k zobrazení nebo podepsání |
|
E-mail příjemce
|
string |
E-mail příjemce |
|
|
Křestní jméno
|
first_name | string |
Jméno příjemce |
|
Jméno a příjmení
|
fullname | string |
Celé jméno příjemce |
|
Pohlaví
|
gender | string |
Pohlaví příjemce |
|
ID
|
id | string |
ID příjemce |
|
Příjmení
|
last_name | string |
Příjmení příjemce |
|
Mobilní zařízení
|
mobile | string |
Mobilní číslo příjemce |
|
Poznámka:
|
note | string |
Poznámka příjemce |
|
Podpisové číslo objednávky
|
order_num | string |
Podpisové pořadí příjemce |
|
Stav
|
status | string |
Stav příjemce |
|
Adresa URL palce
|
thumb_url | string |
Adresa URL příjemce |
|
Title
|
title | string |
Název příjemce |
Příjemci
Seznam příjemců
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient |
Uživatel
Uživatel je definovaný e-mailovou adresou a je připojený k jedné nebo mnoha entitě.
Role uživatelů
Správce:
- Zobrazit všechny dokumenty
- Upravit všechny dokumenty
- Změna nastavení entity, informací a fakturace
- Přidání nových uživatelů do entity
- Přiřazení rolí entit
Manažer:
- Zobrazení týmových dokumentů
- Upravit všechny dokumenty
- Přidání nových uživatelů do entity
Entita
Entita je nejvyšší uzel a všichni uživatelé a odpovídající dokumenty jsou připojené k entitě. Entita je často stejná jako společnost, země nebo oddělení ve velké organizaci.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Režim aplikace
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
Email
|
string |
E-mailová adresa uživatele |
|
|
ID subjektu
|
entity_id | string | |
|
Název entity
|
entity_name | string | |
|
Křestní jméno
|
first_name | string |
Jméno uživatele |
|
ID
|
id | string |
ID uživatele |
|
Jazyk
|
language | string | |
|
Příjmení
|
last_name | string |
Příjmení uživatele |
|
mobilní
|
mobile | string |
Číslo mobilního zařízení v mezinárodním formátu |
|
Poznámka:
|
note | string |
Volitelná interní poznámka pro uživatele |
|
telefon
|
phone | string |
Telefonní číslo v mezinárodním formátu |
|
Role
|
role | string | |
|
Přeskočit odesílání pozvánky
|
skip_invitation | boolean | |
|
Stav
|
status | string | |
|
ID týmu
|
team_id | string | |
|
Adresa URL palce
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Title
|
title | string |
Název uživatele, např. Generální ředitel, manažer prodeje |
Uživatelé
Seznam uživatelů
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
users
|
users | array of object | |
|
Email
|
users.email | string | |
|
Křestní jméno
|
users.first_name | string | |
|
Poslední přihlášení
|
users.last_login | string | |
|
Příjmení
|
users.last_name | string | |
|
Uživatelské jméno
|
users.name | string | |
|
Role
|
users.role | string | |
|
Stav
|
users.status | string | |
|
Název týmu
|
users.team_name | string | |
|
ID uživatele
|
users.user_id | string |
Webhook
Datová část Webhooku
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Vlastní pole
|
custom_fields | object | |
|
Dokument
|
document | Document |
Dokument je jeden nebo více nahraných souborů, které se mají odeslat jednomu nebo mnoha příjemcům vytvořeným uživatelem. |
|
Vlastní doména entity
|
entity.custom_domain | string |
Vlastní nastavení domény pro entitu |
|
Výchozí e-mailová zpráva
|
entity.email_send_message | string |
Výchozí e-mailová zpráva |
|
Výchozí předmět e-mailu
|
entity.email_send_subject | string |
Výchozí předmět e-mailu |
|
Poddoménu entity
|
entity.sub_domain | string |
Poddoménu pro entitu |
|
Název události
|
event | string | |
|
Akce události
|
event_action | string | |
|
Typ události
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
Každou jedinečnou e-mailovou adresu (nebo mobilní číslo), která je připojená k dokumentu, je příjemcem. |
|
Identifikátor předplatného
|
subscription_id | string |