Recipientの更新

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

名前、メールアドレス、説明、metadataを含むrecipientの詳細を更新します。Bank accountの詳細は更新できないことに注意してください。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Recipient ID（例: recp_test_...）。URLパスで指定します。

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

Additional - 4 fieldsAdditional Parameters

▼

`name`STRING(optional)

更新されたrecipient名。

Example:"John Smith"

`email`STRING(optional)

更新されたメールアドレス。

Example:"john.smith@example.com"

`description`STRING(optional)

更新された説明。

Example:"Marketplace seller - Premium"

`metadata`OBJECT(optional)

更新されたmetadata(既存のmetadataを完全に置き換えます)。

Example:{"seller_id":"SELL-12345","tier":"premium"}

---

レスポンス

200

成功

Recipientが正常に更新されました。更新されたrecipientオブジェクトを返します。

更新されたrecipientの属性:

• name - 更新されたrecipient名
• email - 更新されたメールアドレス
• description - 更新された説明
• metadata - 更新されたmetadata
• Bank accountの詳細は変更されません

400

不正なリクエスト

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

一般的な原因:

• メールアドレスの形式が無効
• Metadataの形式が不正
• Metadataが15,000文字を超えている

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが欠落している
• Secret keyが無効
• Secret keyの代わりにpublic keyを使用している
• HTTP Basic Auth形式が正しくない

404

見つかりません

Recipientが見つかりません。

一般的な原因:

• Recipient IDが無効
• Recipientがアカウントに属していない
• Recipientが削除されている
• テストモードとライブモードのIDが混在している

---

Code samples

cURL

curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "name=John Smith" \
  -d "email=john.smith@example.com"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.update('recp_test_5xuy4w91xqz7d1w9u0t', {
  name: 'John Smith',
  email: 'john.smith@example.com'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
recipient.name = 'John Smith'
recipient.email = 'john.smith@example.com'
recipient.update()

Node.js

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

const recipient = await omise.recipients.update('recp_test_5xuy4w91xqz7d1w9u0t', {
  name: 'John Smith',
  email: 'john.smith@example.com'
});

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');
$recipient->update([
    'name' => 'John Smith',
    'email' => 'john.smith@example.com'
]);

Java

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

Recipient recipient = client.recipients()
    .update("recp_test_5xuy4w91xqz7d1w9u0t")
    .name("John Smith")
    .email("john.smith@example.com")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipient = await client.Recipients.Update("recp_test_5xuy4w91xqz7d1w9u0t", new UpdateRecipientRequest
{
    Name = "John Smith",
    Email = "john.smith@example.com"
});

Go

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

recipient, _ := client.Recipients().Update("recp_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateRecipient{
    Name:  "John Smith",
    Email: "john.smith@example.com",
})

---

重要な注意事項

• Bank accountの詳細は更新できません
• Bank accountを変更するには、recipientを削除して新しいものを作成してください
• Metadataパラメータは既存のmetadataを完全に置き換えます
• 既存のmetadataを保持するには、最初にrecipientを取得してマージしてください

---

Try it out

必須 - 1項目

▼

id(必須)

追加 - 4項目

▼