Customerの更新

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

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

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

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

▼

---

レスポンス

200

Customerが正常に更新されました

更新された情報とともにCustomerオブジェクトが返されます。

更新の動作:

• 指定されたフィールドのみが更新されます
• 指定されていないフィールドは変更されません
• metadataはマージされます（置き換えられません）
• cardが指定された場合、新しいカードが追加されデフォルトになります
• 以前のカードは紐付けられたままですが、デフォルトではなくなります

400

不正なリクエスト

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

一般的な原因:

• 無効なメール形式
• 無効なmetadata形式
• metadataが15,000文字を超えています

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが不足しています
• 無効なsecret key
• secret keyではなくpublic keyを使用しています
• HTTP Basic Auth形式が正しくありません

404

見つかりません

Customerまたはtokenが見つかりません。

一般的な原因:

• Customer IDが存在しません
• token IDが存在しません
• tokenはすでに使用されています

---

コードサンプル

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 - Premium Member"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = Omise::Customer.update('cust_test_5xuy4w91xqz7d1w9u0t', {
  email: 'john.updated@example.com',
  description: 'John Doe - Premium Member'
})

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 - Premium Member'
)

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 - Premium Member'
});

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 - Premium Member'
]);

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 - Premium Member")
    .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 - Premium Member"
});

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 - Premium Member",
})

---

エラーと結果コード

一般的なエラーコード

Code	Description	Resolution
bad_request	無効なパラメータ	メール形式とmetadataを確認してください
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
not_found	Customerが見つかりません	Customer IDが存在することを確認してください
used_token	tokenはすでに使用されています	新しいtokenを生成してください
invalid_card	無効なcardのtoken	tokenが有効であることを確認してください

更新フィールド

Field	Description
email	更新されたCustomerのメール
description	更新されたCustomerの説明
default_card	新しいデフォルトのcard（cardが指定された場合）
metadata	マージされたmetadataオブジェクト
cards	すべてのカードのリスト（追加された場合は新しいカードを含む）

---

お試しください

必須 - 1項目

▼

id(必須)

追加 - 4項目

▼