Update Buyer User

PUT /buyers/{buyerId}/buyer_users/{buyerUserId}

Update a buyer user

Path parameters

  • buyerId string(guid) Required

    Unique ID of the buyer

  • buyerUserId string(guid) Required

    Unique ID of the buyer user

application/json

Body

  • buyer_user object
    Hide buyer_user attributes Show buyer_user attributes object
    • full_name string
    • email string(email)
    • role string

      Values are owner or user.

Responses

  • 200 application/json

    Buyer user updated

    Hide response attributes Show response attributes object
    • id string(guid)

      System generated unique identifier. Don't include this in POST request body.

    • full_name string
    • email string(email)
    • role string

      Values are owner or user.

    • status string

      Values are active, inactive, or invited.

    • created_at string(date-time)
    • updated_at string(date-time)
PUT /buyers/{buyerId}/buyer_users/{buyerUserId}
curl \
 --request PUT 'https://app.getfoundation.com/api/external/v1/buyers/{buyerId}/buyer_users/{buyerUserId}' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"buyer_user":{"full_name":"John Doe","email":"hello@example.com","role":"owner"}}'
Request examples
{
  "buyer_user": {
    "full_name": "John Doe",
    "email": "hello@example.com",
    "role": "owner"
  }
}
Response examples (200)
{
  "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "full_name": "John Doe",
  "email": "hello@example.com",
  "role": "owner",
  "status": "active",
  "created_at": "2025-05-04T09:42:00Z",
  "updated_at": "2025-05-04T09:42:00Z"
}