Add a Buyer User

POST /buyers/{buyerId}/buyer_users

Api key auth

Add a new buyer user and send an invitation email

Path parameters

buyerId string(guid) Required

ID of the buyer to add a user to

application/json

Body

buyer_user object
Hide buyer_user attributes Show buyer_user attributes object
- email Required
- full_name Required
- role string
  
  Values are owner or user.

Responses

201 application/json

Buyer user created
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)

POST /buyers/{buyerId}/buyer_users

curl \
 --request POST 'https://stg.getfoundation.com/api/external/v1/buyers/{buyerId}/buyer_users' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"buyer_user":{"full_name":"John Doe","role":"owner"}}'

Request examples

{
  "buyer_user": {
    "full_name": "John Doe",
    "role": "owner"
  }
}

Response examples (201)

{
  "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"
}