Update a recipient

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

Update recipient details including name, email, description, and metadata. Note that bank account details cannot be updated.

---

🔑API Credentials

▼

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Recipient ID (e.g., recp_test_...). Provided in the URL path.

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

Additional - 4 fieldsAdditional Parameters

▼

`name`STRING(optional)

Updated recipient name.

Example:"John Smith"

`email`STRING(optional)

Updated email address.

Example:"john.smith@example.com"

`description`STRING(optional)

Updated description.

Example:"Marketplace seller - Premium"

`metadata`OBJECT(optional)

Updated metadata (completely replaces existing metadata).

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

---

Responses

200

Successful transaction

Recipient updated successfully. Returns the updated recipient object.

Updated recipient attributes:

• name - Updated recipient name
• email - Updated email address
• description - Updated description
• metadata - Updated metadata
• Bank account details remain unchanged

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid email format
• Malformed metadata
• Metadata exceeds 15,000 characters

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Recipient not found.

Common causes:

• Invalid recipient ID
• Recipient does not belong to your account
• Recipient has been deleted
• Mixing test and live mode IDs

---

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

---

Important notes

• Bank account details cannot be updated
• To change bank account, delete the recipient and create a new one
• Metadata parameter completely replaces existing metadata
• To preserve existing metadata, retrieve recipient first and merge

---

Try it out

Required - 1 fields

▼

id(Required)

Additional - 4 fields

▼