Skip to main content
PUT
/
buyers
/
{buyer_id}
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Buyers.UpdateAsync(
    buyerId: "fe26475d-ec3e-4884-9553-f7356683f7f9",
    buyerUpdate: new BuyerUpdate() {}
);

// handle response
{
  "merchant_account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "type": "buyer",
  "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "display_name": "John Doe",
  "external_identifier": "buyer-12345",
  "billing_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email_address": "[email protected]",
    "phone_number": "+1234567890",
    "address": {
      "city": "San Jose",
      "country": "US",
      "postal_code": "94560",
      "state": "California",
      "state_code": "US-CA",
      "house_number_or_name": "10",
      "line1": "Stafford Appartments",
      "line2": "29th Street",
      "organization": "Gr4vy"
    },
    "tax_id": {
      "value": "<string>",
      "kind": "ae.trn"
    }
  },
  "account_number": "<string>"
}
This endpoint requires the buyers.write scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-gr4vy-merchant-account-id
string | null

The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

​
buyer_id
string<uuid>
required

The ID of the buyer to edit.

Body

application/json

Request body for updating an existing buyer

​
display_name
string | null

The display name for the buyer.

Required string length: 1 - 200
Example:

"John Doe"

​
external_identifier
string | null

The merchant identifier for this buyer.

Required string length: 1 - 200
Example:

"buyer-12345"

​
account_number
string | null

The buyer account number

Required string length: 1 - 200
​
billing_details
BillingDetails · object

The billing name, address, email, and other fields for this buyer.

Response

Successful Response

​
merchant_account_id
string
required

The ID of the merchant account this buyer belongs to.

​
created_at
string<date-time>
required

The date this buyer was created at.

​
updated_at
string<date-time>
required

The date this buyer was last updated at.

​
type
string
default:buyer

Always buyer.

Allowed value: "buyer"
​
id
string<uuid> | null

The ID for the buyer.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

​
display_name
string | null

The display name for the buyer.

Required string length: 1 - 200
Example:

"John Doe"

​
external_identifier
string | null

The merchant identifier for this buyer.

Required string length: 1 - 200
Example:

"buyer-12345"

​
billing_details
BillingDetails · object

The billing name, address, email, and other fields for this buyer.

​
account_number
string | null

The buyer account number

Required string length: 1 - 200