レコードの作成

パスで指定されたエンティティに対し、リクエストボディの内容でレコードを作成する

📬 リクエスト

POST {resource_api_url}/records/{entity_name}

リクエストヘッダ

キー	値
Authorization	`Bearer {アクセストークン}`
Content-Type	`application/json`

パスパラメータ

パラメータ	形式	必須	説明	値の例
entity_name	文字列	YES	作成対象レコードのエンティティ名	`account`

リクエストボディ

更新対象のエンティティ項目名と値を持つJSONオブジェクト
値の形式
- 項目のデータ型がtextの場合: 文字列
- 項目のデータ型がnumericの場合
  - 項目のサブデータ型がintegerの場合: 整数値
  - 項目のサブデータ型がdecimalの場合: 小数を含む数値
- 項目のデータ型がbooleanの場合: 真偽値
- 項目のデータ型がdateの場合
  - 項目のサブデータ型がdateの場合: ISO8601日付形式の文字列（YYYY-MM-DD）
  - 項目のサブデータ型がdatetimeの場合: ISO8601日時形式の文字列（YYYY-MM-DDTHH:MM[:SS[.s+]]Z）
  - 項目のサブデータ型がtimeの場合: ISO8601時刻形式の文字列（HH:MM[:SS[.s+]]）
- 項目のデータ型がoptionの場合
  - 項目のサブデータ型がsingleの場合: 文字列（オプション名）
  - 項目のサブデータ型がmultiの場合: 文字列（オプション名）の配列
- 項目のデータ型がreferenceの場合
  - 項目のサブデータ型がsingleの場合: レコード参照オブジェクト
  - 項目のサブデータ型がmultiの場合: レコード参照オブジェクトの配列

レコード参照オブジェクト

フィールド	形式	必須	説明	値の例
entity_name	文字列	YES	参照レコードのエンティティ名	`lead`
id	文字列	YES	参照レコードのID	`lead-00000001`

リクエストボディのサンプル

{
  "text_field": "ABC",
  "textarea_field": "ABC\nDEF",
  "integer_field": 123,
  "decimal_field": 123.45,
  "boolean_field": true,
  "date_field": "2025-01-01",
  "datetime_field": "2025-01-01T12:34:56Z",
  "time_field": "12:34:56",
  "single_option_field": "option-a",
  "multi_option_field": ["option-a", "option-b"],
  "single_reference_field": { "entity_name": "lead", "id": "lead-00000001" },
  "multi_reference_field": [
    { "entity_name": "lead", "id": "lead-00000001" },
    { "entity_name": "lead", "id": "lead-00000002" }
  ]
}

✨ 成功レスポンス

ステータスコード

201 : Created

レスポンスヘッダ

キー	値
Content-Type	`application/json`

レスポンスボディ

フィールド	形式	必須	説明	値の例
entity_name	文字列	YES	作成したレコードのエンティティ名	`account`
id	文字列	YES	作成したレコードのID	`account-00000001`

レスポンスボディのサンプル

{
  "entity_name": "account",
  "id": "account-00000001"
}

💬 具体的な要求事項

基本要求

指定されたエンティティ名とフィールドの値を元に新規レコードを作成してください

その他（補足等）

UPWARDから送信されるリクエストボディには、「is_creatable」フィールドがtrueの項目のみ含まれます（falseの項目についてはサポートする必要はありません）
必要に応じて、貴社が定める仕様に基づいてリクエストボディのバリデーションを行ってください

📚 参考資料

なし