PUT
/
buyers
/
{buyer_id}
curl --request PUT \
  --url https://api.{id}.gr4vy.app/buyers/{buyer_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "display_name": "John Doe",
  "external_identifier": "buyer-12345",
  "account_number": "<string>",
  "billing_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email_address": "john@example.com",
    "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": "12345678931",
      "kind": "us.ein"
    }
  }
}'
{
  "type": "buyer",
  "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "merchant_account_id": "default",
  "display_name": "John Doe",
  "external_identifier": "buyer-12345",
  "billing_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email_address": "john@example.com",
    "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": "12345678931",
      "kind": "us.ein"
    }
  },
  "account_number": "<string>",
  "created_at": "2013-07-16T19:23:00.000+00:00",
  "updated_at": "2013-07-16T19:23:00.000+00:00"
}

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.

Examples:

"default"

Path Parameters

​
buyer_id
string
required

The ID of the buyer to edit.

Examples:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

Query Parameters

​
timeout_in_seconds
number
default:1

Body

application/json

Request body for updating an existing buyer

Response

200
application/json
Successful Response

The response is of type object.