次の方法で共有


GetAccept

GetAccept は、販売促進資料、契約管理、提案書、電子署名を 1 か所で利用しながら、営業が営業ドキュメントを設計、送信、宣伝、追跡、および電子署名できるようにするための、Sales Enablement プラットフォームを提供します。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 GetAccept API チーム
[URL] https://app.getaccept.com/api
メール integrations@getaccept.com
Connector Metadata
発行者 GetAccept, Inc.
Web サイト https://www.getaccept.com
プライバシー ポリシー https://www.getaccept.com/privacy-policy
カテゴリ 販売と CRM; 生産性

GetAccept は、販売促進資料、契約管理、提案書、電子署名を 1 つの場所で活用して、販売ドキュメントを設計、送信、宣伝、追跡、および電子署名するためのセールス イネーブルメント プラットフォームを提供します。 このコネクタは、ドキュメントの保存、取得、タスク割り当て、およびカスタマイズ通知のワークフローを自動化するのに役立ちます。

前提条件

この接続を使用するには、GetAccept のアカウントが必要です。 getaccept.com に移動して、無料アカウントを登録します。

資格情報の入手方法

GetAccept で現在ログインしているユーザーを認証するために OAuth2 が使用されるため、有効な GetAccept アカウントのみが必要です。

既知の問題と制限事項

統合関連の問題に関しては [mailto:support@getaccept.com](technical support) にお問い合わせください。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

テンプレート フィールドの取得

特定のテンプレートのフィールドの一覧を受け取ります。

テンプレート ロールの取得

特定のテンプレートのロールの一覧を受け取ります。

テンプレートの一覧を表示します。

利用可能なドキュメント テンプレートの一覧を受け取ります。 GetAccept のテンプレート セクションで新しいテンプレートを追加できます。

テンプレートの価格表を取得

特定のテンプレートの価格表の項目一覧を受け取ります。

ドキュメント ファイルのアップロード

一度に 1 つのファイルをアップロードして、ファイル ID を取得できます。ファイル ID は、受信者に送信される GetAccept ドキュメントにファイルを接続するために使用されます。 複数のファイルをアップロードする場合は、複数の POST を実行します。 規定では、最大 10 MB のファイルのみを受け入れます。 アップロードしたファイルは、アップロード後 48 時間以内にドキュメントにインポート/追加する必要があります。

送信時に同じ外観を保証するために、PDF ファイルをアップロードすることをお勧めします。 次のような他のファイルの種類を変換できます。

Mirosoft Office : doc、docx、xl、xls、xlsx、ppt、pptx Mac : Numbers、キー画像 : jpg、jpeg、png その他 : html、tex、csv

ドキュメント フィールドの取得

ドキュメントまたはテンプレートのフィールドの一覧を取得します。 ドキュメントに署名する前と後の両方で使用できます。

ドキュメントの一覧表示

使用可能なドキュメントの一覧を取得します

ドキュメントの有効期限を更新する

ドキュメントの有効期限の日時を更新するには、このメソッドを使用します。

ドキュメントの添付ファイルを取得

ドキュメント ID を指定してドキュメントの添付ファイルを取得します。

ドキュメントの詳細の取得

ドキュメント ID を指定して、ドキュメントの詳細を取得します。

ドキュメントまたはテンプレートを作成して送信する

受信者に送信するには、ドキュメントを作成する必要があります。 ドキュメントを作成するときは、file_id を使用して以前にアップロードしたファイルを参照するか、ドキュメントを作成して API 投稿にファイルをアップロードすることを選択できます。 ドキュメントの作成 POST にファイルを含める場合、アップロードできるファイルは 1 つだけです。

file_ids パラメータを使用してアップロードされた既存のファイルを使用するか、file_content を使用してドキュメントを base64 エンコード文字列として送信するか、またはファイル パラメータを使用してマルチパート投稿を行います。

すべての受信者は、有効な電子メールか携帯電話番号のいずれかを持っている必要があります。

すべてのイベントは、要求者 IP アドレスを使用して記録されます。 エンドユーザーのパブリック IP アドレスを含むヘッダー CLIENT_IP を使用して、これを上書きできます。

ドキュメントをダウンロードする

ドキュメント ファイルはいつでもダウンロードできますが、状態が「署名済み」のときにダウンロードすることをお勧めします。

ダウンロード URL を受け取るか、バイナリ ファイルを取得するかを選択できます。

ダウンロード URL は、要求が行われてから 10 分後にアクセスできます。

ドキュメント受信者の取得

特定のドキュメント受信者の一覧を取得します。

ビデオのアップロード

添付ファイルをアップロードして、送信するドキュメントに含めることができます。 リクエストが成功すると、attachment_id が返されます。 attachment_id を使用して、添付ファイルをドキュメントに割り当てます。

ビデオの一覧

エンティティで利用可能なビデオの一覧を受け取ります。 モバイル アプリまたは GetAccept 内に新しいビデオを追加できます。

ユーザーの一覧

現在認証されているエンティティのアクティブ ユーザーの一覧をフェッチする

ユーザーの詳細を取得する

この呼び出しは、単一のユーザーの詳細を返します。 user-id me を使用して、現在認証されているユーザーの詳細と利用可能なエンティティを受け取ります

ユーザーを作成

これにより、現在のエンティティのデータベースに新しい取引先担当者が作成されます

取引先担当者を一覧表示します

現在のエンティティで利用可能な取引先担当者の一覧を受け取ります。 受信者として追加されたすべての取引先担当者は取引先担当者として保存され、そのエンティティで後で使用できます。

取引先担当者を作成する

これにより、現在のエンティティのデータベースに新しい取引先担当者が作成されます

既存のドキュメントを送信する

GetAccept を介してドキュメントを送信すると、すべての受信者に、それぞれ一意の安全なリンクを含む電子メールが配信されます。 この API 呼び出しは、ドキュメント送信アクションをトリガーするもので、document_status = ドラフトのドキュメントに対してのみ実行できます。 ドキュメントは、作成時に指定した受信者に送信されます。

自己署名オプションを使用してドキュメントが作成された場合、送信前に認証済みまたは指定されたユーザーによって自己署名されます。

添付ファイルの一覧

利用可能な添付ファイルの一覧を受け取ります。 新しいドキュメントを使用して、GetAccept に新しい添付ファイルを追加できます。

添付ファイルをアップロードする

添付ファイルをアップロードして、送信するドキュメントに含めることができます。 リクエストが成功すると、attachment_id が返されます。 attachment_id を使用して、添付ファイルをドキュメントに割り当てます。

テンプレート フィールドの取得

特定のテンプレートのフィールドの一覧を受け取ります。

パラメーター

名前 キー 必須 説明
テンプレート ID
templateId True string

テンプレート ID

戻り値

フィールド リスト

Fields
Fields

テンプレート ロールの取得

特定のテンプレートのロールの一覧を受け取ります。

パラメーター

名前 キー 必須 説明
テンプレート ID
templateId True string

テンプレート ID

戻り値

名前 パス 説明
ロール
roles array of object
電子メール
roles.email string
first_name
roles.first_name string
last_name
roles.last_name string
モバイル
roles.mobile string
ロール
roles.role string
role_id
roles.role_id string
role_name
roles.role_name string

テンプレートの一覧を表示します。

利用可能なドキュメント テンプレートの一覧を受け取ります。 GetAccept のテンプレート セクションで新しいテンプレートを追加できます。

パラメーター

名前 キー 必須 説明
すべて表示
showall string

エンティティのすべてのテンプレートを表示する

フォルダー ID
folder_id string

特定のフォルダーにテンプレートを表示する

戻り値

名前 パス 説明
のテンプレート
templates array of object
タグ
templates.tags string
created_at
templates.created_at string
external_editor_type
templates.external_editor_type string
field_count
templates.field_count integer
ID
templates.id string
is_editable
templates.is_editable boolean
is_private
templates.is_private boolean
名前
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
種類
templates.type string
user_id
templates.user_id string
video_id
templates.video_id string
video_thumb_url
templates.video_thumb_url string

テンプレートの価格表を取得

特定のテンプレートの価格表の項目一覧を受け取ります。

パラメーター

名前 キー 必須 説明
テンプレート ID
templateId True string

テンプレート ID

戻り値

価格表

価格設定
PricingTables

ドキュメント ファイルのアップロード

一度に 1 つのファイルをアップロードして、ファイル ID を取得できます。ファイル ID は、受信者に送信される GetAccept ドキュメントにファイルを接続するために使用されます。 複数のファイルをアップロードする場合は、複数の POST を実行します。 規定では、最大 10 MB のファイルのみを受け入れます。 アップロードしたファイルは、アップロード後 48 時間以内にドキュメントにインポート/追加する必要があります。

送信時に同じ外観を保証するために、PDF ファイルをアップロードすることをお勧めします。 次のような他のファイルの種類を変換できます。

Mirosoft Office : doc、docx、xl、xls、xlsx、ppt、pptx Mac : Numbers、キー画像 : jpg、jpeg、png その他 : html、tex、csv

パラメーター

名前 キー 必須 説明
ファイル コンテンツ
file_content string

ファイルを base64 エンコードとして送信します。 ファイルを base64 でエンコードすると、サイズが約 30% 増加します

File name
file_name string

拡張子が付いたドキュメントのファイル名です。 これは、さまざまなファイルの種類を変換するのに役立ちます。

File URL
file_url string

ドキュメント ファイルへの URL です。 ファイルは、認証なしでダウンロードできる必要があります

戻り値

名前 パス 説明
file_id
file_id string

ドキュメントの作成時に file_ids で使用されるアップロードされたファイルの ID

file_status
file_status string

アップロードされたファイルの状態

ドキュメント フィールドの取得

ドキュメントまたはテンプレートのフィールドの一覧を取得します。 ドキュメントに署名する前と後の両方で使用できます。

パラメーター

名前 キー 必須 説明
ドキュメント ID
documentId True string

ドキュメント ID

戻り値

フィールド リスト

フィールド
Fields

ドキュメントの一覧表示

使用可能なドキュメントの一覧を取得します

パラメーター

名前 キー 必須 説明
Filter list on status
filter string

状態のフィルターの一覧

結果を並べ替える方法
sort_by string

結果を並べ替える方法

結果の並べ替え順序
sort_order string

結果の並べ替え順序

チーム メンバーからのドキュメントを含める
showteam boolean

チーム メンバーからのドキュメントを含める

エンティティからのすべてのドキュメントを含める
showall boolean

エンティティからのすべてのドキュメントを含める

外部 ID
external_id string

外部 ID は、GetAccept の外部のシステムからの一意のレコード識別子を含むことができるカスタム フィールド

オフセット
offset number

レコード x から制限まで一覧を開始する

制限
limit number

一覧にするレコードの数

戻り値

ドキュメント リスト

項目
Documents

ドキュメントの有効期限を更新する

ドキュメントの有効期限の日時を更新するには、このメソッドを使用します。

パラメーター

名前 キー 必須 説明
Document ID
documentId True string

Document ID

Expiration date
expiration_date date-time

ドキュメントが期限切れになる日時 (UTC)

通知の送信
send_notification boolean

更新に関する通知を受信者に送信する場合

戻り値

名前 パス 説明
Status
status integer

更新の状態

ドキュメントの添付ファイルを取得

ドキュメント ID を指定してドキュメントの添付ファイルを取得します。

パラメーター

名前 キー 必須 説明
Document ID
documentId True string

Document ID

戻り値

添付ファイルの一覧

Attachments
Attachments

ドキュメントの詳細の取得

ドキュメント ID を指定して、ドキュメントの詳細を取得します。

パラメーター

名前 キー 必須 説明
ドキュメント ID
documentId True string

ドキュメント ID

戻り値

ドキュメントは、ユーザーによって作成された 1 人または複数の受信者に送信される 1 つまたは複数のアップロードされたファイルです。

ドキュメント
Document

ドキュメントまたはテンプレートを作成して送信する

受信者に送信するには、ドキュメントを作成する必要があります。 ドキュメントを作成するときは、file_id を使用して以前にアップロードしたファイルを参照するか、ドキュメントを作成して API 投稿にファイルをアップロードすることを選択できます。 ドキュメントの作成 POST にファイルを含める場合、アップロードできるファイルは 1 つだけです。

file_ids パラメータを使用してアップロードされた既存のファイルを使用するか、file_content を使用してドキュメントを base64 エンコード文字列として送信するか、またはファイル パラメータを使用してマルチパート投稿を行います。

すべての受信者は、有効な電子メールか携帯電話番号のいずれかを持っている必要があります。

すべてのイベントは、要求者 IP アドレスを使用して記録されます。 エンドユーザーのパブリック IP アドレスを含むヘッダー CLIENT_IP を使用して、これを上書きできます。

パラメーター

名前 キー 必須 説明
ID
id string

一覧から、またはアップロード後に受信した添付ファイル ID

表示の要求
require_view boolean

受信者に添付ファイルの表示を要求する

タイプ
type string

ファイルまたは外部。ファイルはアップロードされたファイルであり、外部は外部ファイルへのリンク

フィールド ID
id string

カスタム テンプレート フィールドの ID

フィールド名
name string

カスタム テンプレート フィールドの名前

フィールド値
value string

カスタム テンプレート フィールドの値

通貨型
currency string

通貨、例: SEK

Locale
locale string

ロケール、例: sv-SE

Display Name
display_name string

価格表の表示名

External ID
external_id string

サードパーティ システム内の概要オブジェクトを表す外部 ID

テーブル ID
id string

テーブル ID

事前に計算された合計
pre_calculated boolean

価格表の合計を事前に計算する必要がある場合

Display Name
display_name string

価格表の表示名

ID
id string

Section ID

rows

値オブジェクトを含む配列 (「column_id, 値」の配列)

有効化
enabled boolean

セクションの割引を有効にする場合

一律料金
flat_fee boolean

セクションで一律料金の割引を使用する場合

割引の値
value string

セクションの割引の値

有効化
enabled boolean

セクションで価格を有効にする場合

一律料金
flat_fee boolean

セクションで一律料金の価格を使用する場合

価格の値
value string

セクションの価格の値

有効化
enabled boolean

セクションで税を有効にする場合

一律料金
flat_fee boolean

セクションで一律料金の税を使用する場合

税の値
value string

セクションの税の値

有効化
enabled boolean

価格表で割引を有効にする場合

一律料金
flat_fee boolean

価格表で一律料金の割引を使用する場合

割引の値
value string

概要の割引の値

有効化
enabled boolean

価格表で価格を有効にする場合

一律料金
flat_fee boolean

価格表で一律料金の価格を使用する場合

価格の値
value string

概要の価格の値

有効化
enabled boolean

価格表で税を有効にする場合

一律料金
flat_fee boolean

価格表で一律料金の税を使用する場合

価値
value string

概要の税の値

Expiration date
expiration_date date-time

ドキュメントの有効期限が切れる日時

外部 ID
external_id string

識別用の外部システム ID

ファイル コンテンツ
file_content string

Base64 でエンコードされたファイルのコンテンツ

ファイル ID
file_ids string

ファイルのアップロード時に受信したコンマ区切りの一意のファイル ID

File name
file_name string

拡張子が付いたドキュメントのファイル名です。 これは、さまざまなファイルの種類を変換するのに役立ちます。

File URL
file_url string

ドキュメント ファイルへの URL です。 ドキュメントは公開されており、ダウンロード可能である必要があります

自動的に送信
is_automatic_sending boolean

作成後にドキュメントを送信する必要がある場合

アラームの送信
is_reminder_sending boolean

自動アラームを送信する

送信スケジュール
is_scheduled_sending boolean

将来の送信をスケジュールする

ドキュメントの署名
is_signing boolean

ドキュメントを署名のために送信する

手書きの署名
is_signing_biometric boolean

手書きの署名を使用する

署名の転送を許可する
is_signing_forward boolean

受信者が署名権を譲渡できるようにする

イニシャルで署名する
is_signing_initials boolean

受信者のイニシャルを使用してドキュメントに署名する

SMS の送信
is_sms_sending boolean

ドキュメントをテキストで受信者のモバイルに送信する

ドキュメント名
name True string

ドキュメント名を入力する

会社名
company_name string

受信者の会社名

会社の番号
company_number string

受信者の会社の番号

電子メール
email string

受信者の電子メール アドレス

first_name string

受信者の名

last_name string

受信者の姓

携帯電話
mobile string

国際形式の携帯電話

メモ
note string

受信者への追加のメモ

署名順序
order_num integer

署名順序が有効な場合

受信者の種類
role string

ドキュメント内の受信者の種類

テンプレート ロール
role_name string

テンプレートのロールの名前

検証 EID
verify_eid boolean

EID を使用して検証する

EID の種類
verify_eid_type string

個人検証に使用する EID の種類

質問を有効にする
verify_qna boolean

質問がある場合

検証の回答
verify_qna_answer string

質問への回答

オープンに関する質問
verify_qna_open boolean

ドキュメントを開く前に質問が必要な場合

検証の質問
verify_qna_question string

検証のための質問

署名に関する質問
verify_qna_sign boolean

署名の前に質問が必要な場合

検証 SMS
verify_sms boolean

SMS で受信者を検証する

オープン時に SMS を検証する
verify_sms_open boolean

オープン時に SMS を検証する

SMS で検証する
verify_sms_sign boolean

SMS は署名する前に受信者を確認する必要がある

送信日のスケジュール
scheduled_sending_time date-time

ドキュメントが送信される日時

送信者の電子メールの上書き
sender_email string

認証されたユーザー以外の電子メールから送信する

送信者ユーザーの上書き
sender_id string

認証されたユーザー以外のユーザーから送信する

テンプレート ID
template_id string

送信に使用するテンプレートを選択する

ドキュメントの種類
type string

ドキュメントの種類/カテゴリを設定する

ドキュメントの値
value integer

取引またはドキュメントの値

ビデオ ID
video_id string

送信に使用するビデオを選択する

戻り値

ドキュメントは、ユーザーによって作成された 1 人または複数の受信者に送信される 1 つまたは複数のアップロードされたファイルです。

ドキュメント
Document

ドキュメントをダウンロードする

ドキュメント ファイルはいつでもダウンロードできますが、状態が「署名済み」のときにダウンロードすることをお勧めします。

ダウンロード URL を受け取るか、バイナリ ファイルを取得するかを選択できます。

ダウンロード URL は、要求が行われてから 10 分後にアクセスできます。

パラメーター

名前 キー 必須 説明
ドキュメント ID
documentId True string

ドキュメント ID

バイナリ ファイルを直接返す
direct string

バイナリ ファイルを直接返す

戻り値

名前 パス 説明
document_url
document_url string
ファイル
file string

ドキュメント受信者の取得

特定のドキュメント受信者の一覧を取得します。

パラメーター

名前 キー 必須 説明
ドキュメント ID
documentId True string

ドキュメント ID

戻り値

受信者の一覧

受信者
Recipients

ビデオのアップロード

添付ファイルをアップロードして、送信するドキュメントに含めることができます。 リクエストが成功すると、attachment_id が返されます。 attachment_id を使用して、添付ファイルをドキュメントに割り当てます。

パラメーター

名前 キー 必須 説明
File content
file_content string

ファイルを base64 エンコードとして送信します。 ファイルを base64 でエンコードすると、サイズが約 30% 増加します

File name
file_name string

拡張子が付いたドキュメントのファイル名です。 これは、さまざまなファイルの種類を変換するのに役立ちます。

File URL
file_url string

ドキュメント ファイルへの URL です。 ファイルは、認証なしでダウンロードできる必要があります

戻り値

名前 パス 説明
File status
file_status string

ビデオの状態

File name
filename string

ビデオのファイル名

ジョブ ID
job_id string

ビデオを変換および圧縮する処理ジョブの ID。 /ビデオ/ジョブ/ を使用してジョブの状態の更新をポーリングします。

ビデオ ID
video_id string

ドキュメントの作成時に video_id で使用されるアップロードされたビデオの ID

ビデオの一覧

エンティティで利用可能なビデオの一覧を受け取ります。 モバイル アプリまたは GetAccept 内に新しいビデオを追加できます。

戻り値

名前 パス 説明
のビデオ
videos array of object
editable
videos.editable boolean
公開済み
videos.published boolean
保存済み
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

ユーザーの一覧

現在認証されているエンティティのアクティブ ユーザーの一覧をフェッチする

戻り値

ユーザーのリスト

ユーザー
Users

ユーザーの詳細を取得する

この呼び出しは、単一のユーザーの詳細を返します。 user-id me を使用して、現在認証されているユーザーの詳細と利用可能なエンティティを受け取ります

パラメーター

名前 キー 必須 説明
ユーザー ID
userId True string

ユーザー ID

戻り値

ユーザーはその電子メール アドレスによって定義され、1 つ以上のエンティティに接続されています。

ユーザー ロール

管理者:

  • ドキュメントをすべて表示する
  • ドキュメントをすべて編集する
  • エンティティの設定、情報、請求を変更する
  • 新しいユーザーをエンティティに追加する
  • エンティティ ロールを割り当てる

管理者 :

  • チーム ドキュメントを表示する
  • ドキュメントをすべて編集する
  • 新しいユーザーをエンティティに追加する

Entity

エンティティは最上位ノードであり、すべてのユーザーと対応するドキュメントがエンティティに接続されています。 エンティティとは、多くの場合、会社、国、または大規模な組織の部署と同じです。

ユーザー
User

ユーザーを作成

これにより、現在のエンティティのデータベースに新しい取引先担当者が作成されます

パラメーター

名前 キー 必須 説明
company_name
company_name string

関連会社名

company_number
company_number string

関連会社番号

電子メール
email string

取引先担当者の電子メール アドレス

first_name
first_name string

取引先担当者の名

fullname
fullname string

名/姓の代わりに氏名を指定するために使用する

last_name
last_name string

取引先担当者の姓

モバイル
mobile string

国際形式の携帯電話番号

メモ
note string

取引先担当者のための任意の内部メモ

電話
phone string

国際形式の電話番号

タイトル
title string

取引先担当者の役職、例 : CEO、営業マネージャー

戻り値

ユーザーはその電子メール アドレスによって定義され、1 つ以上のエンティティに接続されています。

ユーザー ロール

管理者:

  • ドキュメントをすべて表示する
  • ドキュメントをすべて編集する
  • エンティティの設定、情報、請求を変更する
  • 新しいユーザーをエンティティに追加する
  • エンティティ ロールを割り当てる

管理者 :

  • チーム ドキュメントを表示する
  • ドキュメントをすべて編集する
  • 新しいユーザーをエンティティに追加する

Entity

エンティティは最上位ノードであり、すべてのユーザーと対応するドキュメントがエンティティに接続されています。 エンティティとは、多くの場合、会社、国、または大規模な組織の部署と同じです。

ユーザー
User

取引先担当者を一覧表示します

現在のエンティティで利用可能な取引先担当者の一覧を受け取ります。 受信者として追加されたすべての取引先担当者は取引先担当者として保存され、そのエンティティで後で使用できます。

戻り値

取引先担当者リスト

Contacts
Contacts

取引先担当者を作成する

これにより、現在のエンティティのデータベースに新しい取引先担当者が作成されます

パラメーター

名前 キー 必須 説明
Company Name
company_name string

関連会社名

会社番号
company_number string

関連会社番号

メール
email string

取引先担当者の電子メール アドレス

First name
first_name string

取引先担当者の名

氏名
fullname string

名/姓の代わりに氏名を指定するために使用する

Last name
last_name string

取引先担当者の姓

携帯
mobile string

国際形式の携帯電話番号

Note
note string

取引先担当者のための任意の内部メモ

電話番号
phone string

国際形式の電話番号

肩書き
title string

取引先担当者の役職、例 : CEO、営業マネージャー

戻り値

名前 パス 説明
連絡先 ID
contact_id string

作成された取引先担当者の ID

既存のドキュメントを送信する

GetAccept を介してドキュメントを送信すると、すべての受信者に、それぞれ一意の安全なリンクを含む電子メールが配信されます。 この API 呼び出しは、ドキュメント送信アクションをトリガーするもので、document_status = ドラフトのドキュメントに対してのみ実行できます。 ドキュメントは、作成時に指定した受信者に送信されます。

自己署名オプションを使用してドキュメントが作成された場合、送信前に認証済みまたは指定されたユーザーによって自己署名されます。

パラメーター

名前 キー 必須 説明
ドキュメント ID
documentId True string

ドキュメント ID

sender_email
sender_email email

これを使用して、ドキュメントの自己署名に使用する送信者ユーザー/所有者を電子メール アドレスで指定します。

sender_id
sender_id string

これを使用して、ドキュメントの自己署名に使用する送信者ユーザー/所有者を ID で指定します。

戻り値

ドキュメントは、ユーザーによって作成された 1 人または複数の受信者に送信される 1 つまたは複数のアップロードされたファイルです。

ドキュメント
Document

添付ファイルの一覧

利用可能な添付ファイルの一覧を受け取ります。 新しいドキュメントを使用して、GetAccept に新しい添付ファイルを追加できます。

戻り値

添付ファイルの一覧

Attachments
Attachments

添付ファイルをアップロードする

添付ファイルをアップロードして、送信するドキュメントに含めることができます。 リクエストが成功すると、attachment_id が返されます。 attachment_id を使用して、添付ファイルをドキュメントに割り当てます。

パラメーター

名前 キー 必須 説明
File content
file_content string

ファイルを base64 エンコードとして送信します。 ファイルを base64 でエンコードすると、サイズが約 30% 増加します

File name
file_name string

拡張子が付いたドキュメントのファイル名です。 これは、さまざまなファイルの種類を変換するのに役立ちます。

File URL
file_url string

ドキュメント ファイルへの URL です。 ファイルは、認証なしでダウンロードできる必要があります

戻り値

名前 パス 説明
File name
filename string

添付ファイルのファイル名

Attachment ID
id string

ドキュメントの作成時に attachment_id で使用されるアップロードされた添付ファイルの ID

添付ファイルのタイトル
title string

添付ファイルのタイトル

添付ファイルの種類
type string

添付ファイルの種類

トリガー

ドキュメント イベントの購読

この呼び出しにより、新しいサブスクリプションが作成されます。 REST フック標準に従って、単一のオブジェクトの場合でも、応答は配列にラップされます。

イベント

  • document.created - ドキュメントが作成される
  • document.sent - ドキュメントが送信される
  • document.viewed - ドキュメントが送信される
  • document.signed - ドキュメントが署名される
  • document.approved - ドキュメントが承認される
  • document.expired - ドキュメントの有効期限が切れている
  • document.rejected - ドキュメントが拒否される
  • document.downloaded - ドキュメントがダウンロードされる
  • document.printed - ドキュメントが印刷される
  • document.forwarded - ドキュメントが転送される
  • document.partially_signed - ドキュメントが部分的に署名されている
  • document.commented - ドキュメントがコメントされる
  • document.hardbounced - ドキュメントがハードバウンスされる
  • document.imported - ドキュメントがインポートされる
ドキュメントがレビューされたとき

ドキュメントが受信者のいずれかによってレビューされたときにトリガーされる

ドキュメントが拒否されたとき

ドキュメントが受信者のいずれかによって拒否されたときにトリガーされる

ドキュメントが署名されたとき

ドキュメントがすべての署名者によって署名されたときにトリガーされる

ドキュメント イベントの購読

この呼び出しにより、新しいサブスクリプションが作成されます。 REST フック標準に従って、単一のオブジェクトの場合でも、応答は配列にラップされます。

イベント

  • document.created - ドキュメントが作成される
  • document.sent - ドキュメントが送信される
  • document.viewed - ドキュメントが送信される
  • document.signed - ドキュメントが署名される
  • document.approved - ドキュメントが承認される
  • document.expired - ドキュメントの有効期限が切れている
  • document.rejected - ドキュメントが拒否される
  • document.downloaded - ドキュメントがダウンロードされる
  • document.printed - ドキュメントが印刷される
  • document.forwarded - ドキュメントが転送される
  • document.partially_signed - ドキュメントが部分的に署名されている
  • document.commented - ドキュメントがコメントされる
  • document.hardbounced - ドキュメントがハードバウンスされる
  • document.imported - ドキュメントがインポートされる

パラメーター

名前 キー 必須 説明
イベントを選択
event True string

イベント トリガー

すべてのエンティティ ユーザー
global boolean

webhook がすべてのエンティティ ユーザーのイベントをキャッチする場合。

エラー用電子メール
notification_email string

イベントが失敗した場合は、送信者ではなくこのメールに通知を送信する

ペイロード
payload string

投稿する追加のペイロード データ

戻り値

Webhook ペイロード

webhook
Webhook

ドキュメントがレビューされたとき

ドキュメントが受信者のいずれかによってレビューされたときにトリガーされる

パラメーター

名前 キー 必須 説明
すべてのエンティティ ユーザー
global boolean

webhook がすべてのエンティティ ユーザーのイベントをキャッチする場合。

エラー用電子メール
notification_email string

イベントが失敗した場合は、送信者ではなくこのメールに通知を送信する

ペイロード
payload string

投稿する追加のペイロード データ

戻り値

Webhook ペイロード

webhook
Webhook

ドキュメントが拒否されたとき

ドキュメントが受信者のいずれかによって拒否されたときにトリガーされる

パラメーター

名前 キー 必須 説明
すべてのエンティティ ユーザー
global boolean

webhook がすべてのエンティティ ユーザーのイベントをキャッチする場合。

エラー用電子メール
notification_email string

イベントが失敗した場合は、送信者ではなくこのメールに通知を送信する

ペイロード
payload string

投稿する追加のペイロード データ

戻り値

Webhook ペイロード

webhook
Webhook

ドキュメントが署名されたとき

ドキュメントがすべての署名者によって署名されたときにトリガーされる

パラメーター

名前 キー 必須 説明
すべてのエンティティ ユーザー
global boolean

webhook がすべてのエンティティ ユーザーのイベントをキャッチする場合。

エラー用電子メール
notification_email string

イベントが失敗した場合は、送信者ではなくこのメールに通知を送信する

Payload
payload string

投稿する追加のペイロード データ

戻り値

Webhook ペイロード

ウェブフック
Webhook

定義

添付

ドキュメントの添付ファイル

名前 パス 説明
アクセスできる受信者
access_recipient_names array of string

添付ファイルへのアクセスが許可された受信者

Description
attachment_description string

添付ファイルの説明

Download URL
attachment_download_url string

添付ファイルをダウンロードする URL

ファイル拡張子
attachment_extension string

添付ファイルのファイル拡張子

Filename
attachment_filename string

添付ファイルのファイル名

ID
attachment_id string

添付ファイルの ID

Preview URL
attachment_preview_url string

添付ファイルをプレビューする内部 URL

肩書き
attachment_title string

添付ファイルのタイトル

タイプ
attachment_type string

添付ファイルの種類

[URL]
attachment_url string

添付ファイルの URL

最後のビュー
last_attachment_view string

添付ファイルが最後に表示された日時

アクセス制限
restrict_access boolean

添付ファイルへのアクセスが制限されています

Attachments

添付ファイルの一覧

名前 パス 説明
attachments
attachments array of Attachment

お問い合わせ先

一意のメール アドレス (または携帯電話番号) はすべて、取引先担当者として定義されます。

名前 パス 説明
Company ID
company_id string

企業 ID

Company logo
company_logo_url string

会社のロゴ

Company name
company_name string

取引先担当者の会社名

Company number
company_number string

取引先担当者の会社番号

Contact ID
contact_id string

取引先担当者 ID

Created
created_at string

取引先担当者の作成日

Documents
document_count number

取引先担当者のドキュメントの数

Contact email
email string

作成されたドキュメントの名前

First name
first_name string

取引先担当者の名

Full name
fullname string

取引先担当者の氏名

Gender
gender string

受信者の性別

Last name
last_name string

取引先担当者の姓

Mobile
mobile string

取引先担当者の携帯電話番号

Note
note string

取引先担当者のメモ

Thumb URL
thumb_url string

取引先担当者のサム URL

Title
title string

取引先担当者のタイトル

Contacts

取引先担当者リスト

名前 パス 説明
contacts
contacts array of Contact

Document

ドキュメントは、ユーザーによって作成された 1 人または複数の受信者に送信される 1 つまたは複数のアップロードされたファイルです。

名前 パス 説明
Tags
tags string

ドキュメント タグ

Automatic chat text
auto_comment_text string

Automatic chat text

Company Name
company_name string

会社名

Created at
created_at string

ドキュメントの作成時期

Download URL
download_url string

署名済みドキュメントをダウンロードする URL

Email message
email_send_message string

メール メッセージを送信中

Email Subject
email_send_subject string

メールの件名テキスト

Expiration date
expiration_date string

ドキュメントの有効期限

External Client ID
external_client_id string
External Editor ID
external_editor_id string

外部エディターの ID

External Editor Type
external_editor_type string
External ID
external_id string
Field count
field_count integer

ドキュメントのフィールド数

ID
id string
Auto comment
is_auto_comment boolean

自動チャットのコメントが有効な場合

Auto Comment Email
is_auto_comment_email boolean

自動チャットのメールが有効な場合

Identify Recipient
is_identify_recipient boolean

ドキュメントで受信者識別が有効な場合

Is private
is_private boolean

ドキュメントが非公開の場合

Send reminders
is_reminder_sending boolean

自動アラームが有効な場合

Scheduled sending
is_scheduled_sending boolean

ドキュメントの送信がスケジュールされている場合

Self-signing
is_selfsign boolean

ドキュメントが送信者によって自己署名されている場合

Is signed
is_signed boolean

ドキュメントが署名されている場合

Signable document
is_signing boolean

ドキュメントが署名可能な場合

Handwritten signature
is_signing_biometric boolean

手書きの署名が有効な場合

Allow signature transfer
is_signing_forward boolean

署名する権利の転送が有効な場合

Signature order
is_signing_order boolean

受信者の署名順序が有効な場合

Has Video
is_video boolean

ドキュメントに紹介ビデオがある場合

Name
name string

ドキュメントの名前

Parent ID
parent_id string

以前のドキュメント バージョンの ID

Preview URL
preview_url string

ドキュメントの内部プレビューへのリンク

recipients
recipients array of Recipient
Scheduled sending time
scheduled_sending_time string

ドキュメントの送信スケジュールが設定された時期

Send date
send_date string

ドキュメント送信日

Sender email
sender_email string

送信したユーザーのメール アドレス

Sender name
sender_name string

送信したユーザーの名前

Sender thumb URL
sender_thumb_url string

送信したユーザーのサムネ画像

Send date
sign_date string

ドキュメントの署名日

Status
status string

ドキュメントの現在の状態

Thumb URL
thumb_url string

ドキュメントのサムネ画像

Type
type string

ドキュメントの種類

Unique ID
unique_id integer

ドキュメントを表す一意の ID

User ID
user_id string

送信するユーザーの ID

Value
value integer

ドキュメントの価値

Documents

ドキュメント リスト

名前 パス 説明
tags
tags string
company_name
company_name string
created_at
created_at string
expiration_date
expiration_date string
ID
id string
is_private
is_private boolean
is_signing
is_signing boolean
名称
name string
sender_name
sender_name string
sender_thumb
sender_thumb string
ステータス
status string
タイプ
type string
価値
value integer

EditorField

エディター フィールドの詳細

名前 パス 説明
ID
id string

ID

Label
input_settings.label string

Label

オプション
input_settings.options array of string

オプション

Required
input_settings.required boolean

Required

タイプ
input_settings.type string

タイプ

受信者 ID
recipient_id string

受信者 ID

タイプ
type string

タイプ

User ID
user_id string

User ID

Field

フィールドの詳細

名前 パス 説明
Company Name
company_name string

Company Name

会社番号
company_number string

会社番号

Field ID
field_id string

Field ID

Label
field_label string

Label

オプション
field_options array of object

オプション

価値
field_options.value string
タイプ
field_type string

タイプ

価値
field_value string

価値

is_collectable
is_collectable boolean

収集フィールド

is_editable
is_editable boolean

編集可能フィールド

is_required
is_required boolean

必須フィールド

ページ ID
page_id string

ページ ID

受信者 ID
recipient_id string

受信者 ID

受取人の名前
recipient_name string

受取人の名前

Role Name
role_name string

Role Name

Fields

フィールド リスト

名前 パス 説明
editor_fields
editor_fields array of EditorField
fields
fields array of Field

PricingColumn

価格表の列

名前 パス 説明
ID
column_id string

ID

Display Name
display_name string

Display Name

有効化
enabled boolean

有効化

件名
name string

件名

PricingSection

価格表のセクション

名前 パス 説明
columns
columns array of PricingColumn
Display Name
display_name string

Display Name

件名
name string

件名

ID
section_id string

ID

PricingTable

価格表

名前 パス 説明
通貨型
currency_settings.currency string

通貨型

Locale
currency_settings.locale string

Locale

事前に計算された合計
pre_calculated boolean

事前に計算された合計

セクション
sections array of PricingSection
ID
table_id string

テーブル ID

PricingTables

価格表

名前 パス 説明
pricing_tables
pricing_tables array of PricingTable

Recipient

ドキュメントに接続されている一意のメール アドレス (または携帯電話番号) はすべて受信者です。

名前 パス 説明
会社名
company_name string

受信者の会社名

会社の番号
company_number string

受信者の会社の番号

Document URL
document_url string

受信者が表示/署名するための一意の URL

Recipient email
email string

受信者のメール

First name
first_name string

受信者の名

Full name
fullname string

受信者の氏名

性別
gender string

受信者の性別

ID
id string

受信者の ID

last_name string

受信者の姓

携帯電話
mobile string

受信者の携帯電話番号

メモ
note string

受信者のメモ

署名順序の数
order_num string

受信者の署名順序

ステータス
status string

受信者の状態

サム URL
thumb_url string

受信者のサム URL

敬称
title string

受信者の敬称

受信者

受信者の一覧

名前 パス 説明
受信者
recipients array of Recipient

ユーザー

ユーザーはその電子メール アドレスによって定義され、1 つ以上のエンティティに接続されています。

ユーザー ロール

管理者:

  • ドキュメントをすべて表示する
  • ドキュメントをすべて編集する
  • エンティティの設定、情報、請求を変更する
  • 新しいユーザーをエンティティに追加する
  • エンティティ ロールを割り当てる

管理者 :

  • チーム ドキュメントを表示する
  • ドキュメントをすべて編集する
  • 新しいユーザーをエンティティに追加する

Entity

エンティティは最上位ノードであり、すべてのユーザーと対応するドキュメントがエンティティに接続されています。 エンティティとは、多くの場合、会社、国、または大規模な組織の部署と同じです。

名前 パス 説明
アプリ モデル
app_mode string
disallow_create
disallow_create boolean
電子メール
email string

ユーザーのメール アドレス

エンティティ ID
entity_id string
エンティティ名
entity_name string
first_name string

ユーザーの名

ID
id string

ユーザーの ID

言語
language string
last_name string

ユーザーの姓

モバイル
mobile string

国際形式の携帯電話番号

メモ
note string

ユーザーのための任意の内部メモ

電話
phone string

国際形式の電話番号

役割
role string
招待状の送信のスキップ
skip_invitation boolean
ステータス
status string
チーム ID
team_id string
サム URL
thumb_url string
タイムゾーン
timezone string
敬称
title string

ユーザーの役職、例 : CEO、営業マネージャー

Users

ユーザーのリスト

名前 パス 説明
users
users array of object
Email
users.email string
First Name
users.first_name string
Last Login
users.last_login string
Last Name
users.last_name string
User Name
users.name string
Role
users.role string
Status
users.status string
Team Name
users.team_name string
User ID
users.user_id string

Webhook

Webhook ペイロード

名前 パス 説明
Custom Fields
custom_fields object
Document
document Document

ドキュメントは、ユーザーによって作成された 1 人または複数の受信者に送信される 1 つまたは複数のアップロードされたファイルです。

Entity custom domain
entity.custom_domain string

エンティティのカスタム ドメイン設定

Default email message
entity.email_send_message string

Default email message

既定のメールの件名
entity.email_send_subject string

既定のメールの件名

Entity sub-domain
entity.sub_domain string

エンティティのサブドメイン

Event name
event string
Event action
event_action string
Event type
event_type string
Recipient
recipient Recipient

ドキュメントに接続されている一意のメール アドレス (または携帯電話番号) はすべて受信者です。

Subscription ID
subscription_id string