クラウドサイン Web API アップデート〜入力項目のレスポンス項目変更〜

2026年8月27日（木）

いつもクラウドサインをご利用いただきありがとうございます。
クラウドサインWeb APIにおいて、入力項目に関するレスポンス項目の変更をお知らせいたします。

本リリースは既存項目への変更をともないませんので、Web APIをご利用中のお客様への影響は原則ございません。
内容をご確認のうえ、必要に応じて新項目のご活用をご検討ください。

概要

2026年3月にクラウドサイン画面上からの「入力ボックスの横幅サイズ変更」をリリースしましたが、Web API でもご利用可能になります。
本リリースは以下2点となります。

レスポンス項目の追加
リクエストパラメータの追加

これまでは、入力項目の幅が入力文字列の長さに応じて自動的に決まるため、文字数が多い場合に隣接する項目と重なってしまい書類として見づらくなるケースがありました。
今回の変更により、Web API経由でも幅を固定で指定ができるようになります。

リリース詳細

1. レスポンス項目の追加

widget Model に以下のレスポンス項目を追加します。既存項目 w（幅）・h（高さ）の値・意味に変更はありません。
※ どちらも、装飾を含まない値です

inner_width：入力項目の幅
inner_height：入力項目の高さ

2. リクエストパラメータの追加（推奨・対応不要）

フリーテキストのリクエストパラメータに inner_width（幅指定）を追加します。指定すると、入力項目の幅を固定値として扱うことができます。
既存のパラメータへの影響はなく、現在のご利用に変更は不要です。
新規に実装される場合は、inner_width・inner_height のご利用を推奨いたします。

変更日

2026年8月27日（木）

影響範囲（対象エンドポイント）

フリーテキスト・チェックボックス・押印など、すべての種別の入力項目が対象です。widgets配列を含むレスポンスを返すすべてのエンドポイントに影響します（項目追加のみで、既存の値・挙動には影響しません）

入力項目（widgets）の情報を含むレスポンスを返す、以下のエンドポイントが対象です。

■書類（documents）

POST /documents
GET /documents
GET /documents/{documentID}
PUT /documents/{documentID}
POST /documents/{documentID}
PUT /documents/{documentID}/decline

■ファイル（files）

POST /documents/{documentID}/files
DELETE /documents/{documentID}/files/{fileID}

■宛先（participants）

POST /documents/{documentID}/participants
PUT /documents/{documentID}/participants/{participantID}
DELETE /documents/{documentID}/participants/{participantID}

■入力項目（widgets）

POST /documents/{documentID}/files/{fileID}/widgets
PUT /documents/{documentID}/files/{fileID}/widgets/{widgetID}
DELETE /documents/{documentID}/files/{fileID}/widgets/{widgetID}

■共有先（reportees）

POST /documents/{documentID}/reportees
PUT /documents/{documentID}/reportees/{reporteeID}
DELETE /documents/{documentID}/reportees/{reporteeID}

■添付書類（attachments）

POST /documents/{documentID}/attachments
PUT /documents/{documentID}/attachments/{attachmentID}
DELETE /documents/{documentID}/attachments/{attachmentID}

■チームの書類一覧（team_documents ※エンタープライズプランでは使用不可）

GET /team_documents

■キャビネット内の書類一覧（cabinet_documents ※エンタープライズプラン限定）

GET /cabinet_documents

ご確認事項

本対応は、レスポンスへの項目追加およびリクエストパラメータの追加による非破壊的な変更であり、既存のご利用方法や実装への影響はございません。
既存のレスポンス項目 w（幅）・h（高さ）は、値・意味とも変更ありません。
新規に入力項目のサイズ制御を実装される場合は、inner_width・inner_height のご利用をご検討ください。