顧客を更新

PATCHhttps://api.omise.co/customers/:id

説明、メール、メタデータ、デフォルトカードを含む既存の顧客情報を更新します。すべてのパラメータはオプションです - 更新したいフィールドのみを指定してください。

---

リクエストパラメータ

必須 - 1 フィールドパスパラメータ

▼

`id`STRING(required)

更新する顧客ID（cust_で始まる必要があります）。

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効な顧客IDである必要があります

追加 - 4 フィールドオプションパラメータ

▼

---

レスポンス

200

顧客が正常に更新されました

更新された情報を含む顧客オブジェクトが返されます。

更新動作:

• 提供されたフィールドのみが更新されます
• 提供されていないフィールドは変更されません
• メタデータはマージされます（置換されません）
• cardが提供された場合、新しいカードが追加されデフォルトになります
• 以前のカードは添付されたままですが、デフォルトではなくなります

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• 無効なメール形式
• 無効なメタデータ形式
• メタデータが15,000文字を超過

401

認証エラー

認証に失敗しました。APIキーが無効または不足しています。

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• HTTP Basic Auth形式の誤り

404

見つかりません

顧客またはトークンが見つかりません。

一般的な原因:

• 顧客IDが存在しない
• トークンIDが存在しない
• トークンがすでに使用済み

5xx

サーバーエラー

サーバー側でエラーが発生しました。稀ですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "email=john.updated@example.com" \
  -d "description=John Doe - プレミアムメンバー"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = Omise::Customer.update('cust_test_5xuy4w91xqz7d1w9u0t', {
  email: 'john.updated@example.com',
  description: 'John Doe - プレミアムメンバー'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')
customer.update(
    email='john.updated@example.com',
    description='John Doe - プレミアムメンバー'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const customer = await omise.customers.update('cust_test_5xuy4w91xqz7d1w9u0t', {
  email: 'john.updated@example.com',
  description: 'John Doe - プレミアムメンバー'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');
$customer->update([
    'email' => 'john.updated@example.com',
    'description' => 'John Doe - プレミアムメンバー'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Customer customer = client.customers().update("cust_test_5xuy4w91xqz7d1w9u0t")
    .email("john.updated@example.com")
    .description("John Doe - プレミアムメンバー")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var customer = await client.Customers.Update("cust_test_5xuy4w91xqz7d1w9u0t", new UpdateCustomerRequest
{
    Email = "john.updated@example.com",
    Description = "John Doe - プレミアムメンバー"
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

customer, _ := client.Customers().Update("cust_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateCustomer{
    Email:       "john.updated@example.com",
    Description: "John Doe - プレミアムメンバー",
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
bad_request	無効なパラメータ	メール形式とメタデータを確認
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
not_found	顧客が見つからない	顧客IDが存在するか確認
used_token	トークンがすでに使用済み	新しいトークンを生成
invalid_card	無効なカードトークン	トークンが有効か確認

更新フィールド

フィールド	説明
email	更新された顧客メール
description	更新された顧客の説明
default_card	新しいデフォルトカード（カードが提供された場合）
metadata	マージされたメタデータオブジェクト
cards	すべてのカードのリスト（追加された場合は新しいカードを含む）

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

追加 - 4項目

▼

あなたのIP: ...読み込み中...