Update Auction Buyer Details

PUT

api

{portfolio}

portfolios

facilities

{facilityUuid}

auctions

buyer-details

{auctionUuid}

Update Auction Buyer Details

curl --request PUT \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "buyerName": "<string>",
  "buyerEmail": "<string>",
  "buyerPhone": "<string>",
  "winningBidAmountInPennies": 1,
  "cleanOutDate": "2023-11-07T05:31:56Z",
  "auctionNotes": "<string>"
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}"

payload = {
    "buyerName": "<string>",
    "buyerEmail": "<string>",
    "buyerPhone": "<string>",
    "winningBidAmountInPennies": 1,
    "cleanOutDate": "2023-11-07T05:31:56Z",
    "auctionNotes": "<string>"
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    buyerName: '<string>',
    buyerEmail: '<string>',
    buyerPhone: '<string>',
    winningBidAmountInPennies: 1,
    cleanOutDate: '2023-11-07T05:31:56Z',
    auctionNotes: '<string>'
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'buyerName' => '<string>',
    'buyerEmail' => '<string>',
    'buyerPhone' => '<string>',
    'winningBidAmountInPennies' => 1,
    'cleanOutDate' => '2023-11-07T05:31:56Z',
    'auctionNotes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}"

	payload := strings.NewReader("{\n  \"buyerName\": \"<string>\",\n  \"buyerEmail\": \"<string>\",\n  \"buyerPhone\": \"<string>\",\n  \"winningBidAmountInPennies\": 1,\n  \"cleanOutDate\": \"2023-11-07T05:31:56Z\",\n  \"auctionNotes\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"buyerName\": \"<string>\",\n  \"buyerEmail\": \"<string>\",\n  \"buyerPhone\": \"<string>\",\n  \"winningBidAmountInPennies\": 1,\n  \"cleanOutDate\": \"2023-11-07T05:31:56Z\",\n  \"auctionNotes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"buyerName\": \"<string>\",\n  \"buyerEmail\": \"<string>\",\n  \"buyerPhone\": \"<string>\",\n  \"winningBidAmountInPennies\": 1,\n  \"cleanOutDate\": \"2023-11-07T05:31:56Z\",\n  \"auctionNotes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "auctionUuid": "123e4567-e89b-12d3-a456-426614174000",
  "auctionStage": "SCHEDULED",
  "auctionStartDate": "2024-01-15T10:00:00.000Z",
  "auctionEndDate": "2024-01-15T18:00:00.000Z",
  "minimumBidAmount": 10000,
  "winningBidAmount": 25000,
  "buyerName": "John Doe",
  "buyerEmail": "buyer@example.com",
  "buyerPhone": "5551234567",
  "auctionNotes": "Buyer picking up Sat AM, bringing trailer",
  "auctionScheduledOnDate": "2024-01-10T00:00:00.000Z",
  "auctionCompletedOnDate": "2024-01-16T00:00:00.000Z",
  "auctionCanceledOnDate": "2024-01-14T00:00:00.000Z",
  "cleanOutDate": "2024-01-20T00:00:00.000Z",
  "unitRentalRecordUuid": "123e4567-e89b-12d3-a456-426614174000",
  "contentCategories": [
    "Furniture",
    "Electronics"
  ],
  "content": "Household items and boxes",
  "photos": [
    {
      "url": "https://communication-media.cdn.production.monument.io/auctions/photo1.jpg",
      "isPrimary": true,
      "photoType": "UNIT_CONTENTS"
    }
  ],
  "tamperTagId": "TAG-12345",
  "requiresNotice": false
}

Headers

x-api-key

any

required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid

string

required

auctionUuid

string

required

Body

application/json

Winning buyer details sent by the auction platform.

buyerName

string

required

Maximum string length: 200

buyerEmail

string

required

Maximum string length: 100

buyerPhone

string

required

winningBidAmountInPennies

number

required

Amount in pennies

Required range: x >= 0

cleanOutDate

string<date-time> | null

auctionNotes

string | null

Notes about the auction sale and winning buyer, such as pickup arrangements. Saved only when the auction has no notes yet; existing notes are never overwritten. Values longer than 200 characters are truncated. Ignored while the auction is waiting for clean-out, when only cleanOutDate can change.

Response

Auction buyer details updated successfully

auctionUuid

string<uuid>

required

Auction UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

auctionStage

enum<string>

required

Auction stage

Available options:

NOT_SCHEDULED,

SCHEDULED,

PAYMENT_PENDING,

WAITING_FOR_CLEAN_OUT,

COMPLETED,

CANCELED,

UNSOLD

Example:

"SCHEDULED"

auctionStartDate

string<date-time> | null

required

Auction start date

Example:

"2024-01-15T10:00:00.000Z"

auctionEndDate

string<date-time> | null

required

Auction end date

Example:

"2024-01-15T18:00:00.000Z"

minimumBidAmount

number | null

required

Minimum opening bid in pennies (e.g. $100.00 = 10000)

Example:

10000

winningBidAmount

number | null

required

Final sale price in pennies (e.g. $250.00 = 25000)

Example:

25000

buyerName

string | null

required

Buyer name

Example:

"John Doe"

buyerEmail

string | null

required

Buyer email

Example:

"buyer@example.com"

buyerPhone

string | null

required

Buyer phone

Example:

"5551234567"

auctionNotes

string | null

required

Notes about the auction sale and winning buyer, such as pickup arrangements. Sent by the auction platform with the buyer details or entered by the facility.

Maximum string length: 200

Example:

"Buyer picking up Sat AM, bringing trailer"

auctionScheduledOnDate

string<date-time> | null

required

Date auction was scheduled

Example:

"2024-01-10T00:00:00.000Z"

auctionCompletedOnDate

string<date-time> | null

required

Date auction was completed

Example:

"2024-01-16T00:00:00.000Z"

auctionCanceledOnDate

string<date-time> | null

required

Date auction was canceled

Example:

"2024-01-14T00:00:00.000Z"

cleanOutDate

string<date-time> | null

required

Clean out date

Example:

"2024-01-20T00:00:00.000Z"

unitRentalRecordUuid

string<uuid>

required

Unit rental record UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

contentCategories

string[]

required

Content category descriptions

Example:

["Furniture", "Electronics"]

content

string | null

required

Contents description

Example:

"Household items and boxes"

photos

object[]

required

Auction photos

Show child attributes

tamperTagId

string | null

required

Tamper tag ID

Example:

"TAG-12345"

requiresNotice

boolean

required

Whether the auction requires public notice

Example:

false

Update Auction Buyer Details

curl --request PUT \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "buyerName": "<string>",
  "buyerEmail": "<string>",
  "buyerPhone": "<string>",
  "winningBidAmountInPennies": 1,
  "cleanOutDate": "2023-11-07T05:31:56Z",
  "auctionNotes": "<string>"
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}"

payload = {
    "buyerName": "<string>",
    "buyerEmail": "<string>",
    "buyerPhone": "<string>",
    "winningBidAmountInPennies": 1,
    "cleanOutDate": "2023-11-07T05:31:56Z",
    "auctionNotes": "<string>"
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    buyerName: '<string>',
    buyerEmail: '<string>',
    buyerPhone: '<string>',
    winningBidAmountInPennies: 1,
    cleanOutDate: '2023-11-07T05:31:56Z',
    auctionNotes: '<string>'
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'buyerName' => '<string>',
    'buyerEmail' => '<string>',
    'buyerPhone' => '<string>',
    'winningBidAmountInPennies' => 1,
    'cleanOutDate' => '2023-11-07T05:31:56Z',
    'auctionNotes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}"

	payload := strings.NewReader("{\n  \"buyerName\": \"<string>\",\n  \"buyerEmail\": \"<string>\",\n  \"buyerPhone\": \"<string>\",\n  \"winningBidAmountInPennies\": 1,\n  \"cleanOutDate\": \"2023-11-07T05:31:56Z\",\n  \"auctionNotes\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"buyerName\": \"<string>\",\n  \"buyerEmail\": \"<string>\",\n  \"buyerPhone\": \"<string>\",\n  \"winningBidAmountInPennies\": 1,\n  \"cleanOutDate\": \"2023-11-07T05:31:56Z\",\n  \"auctionNotes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/auctions/buyer-details/{auctionUuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"buyerName\": \"<string>\",\n  \"buyerEmail\": \"<string>\",\n  \"buyerPhone\": \"<string>\",\n  \"winningBidAmountInPennies\": 1,\n  \"cleanOutDate\": \"2023-11-07T05:31:56Z\",\n  \"auctionNotes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "auctionUuid": "123e4567-e89b-12d3-a456-426614174000",
  "auctionStage": "SCHEDULED",
  "auctionStartDate": "2024-01-15T10:00:00.000Z",
  "auctionEndDate": "2024-01-15T18:00:00.000Z",
  "minimumBidAmount": 10000,
  "winningBidAmount": 25000,
  "buyerName": "John Doe",
  "buyerEmail": "buyer@example.com",
  "buyerPhone": "5551234567",
  "auctionNotes": "Buyer picking up Sat AM, bringing trailer",
  "auctionScheduledOnDate": "2024-01-10T00:00:00.000Z",
  "auctionCompletedOnDate": "2024-01-16T00:00:00.000Z",
  "auctionCanceledOnDate": "2024-01-14T00:00:00.000Z",
  "cleanOutDate": "2024-01-20T00:00:00.000Z",
  "unitRentalRecordUuid": "123e4567-e89b-12d3-a456-426614174000",
  "contentCategories": [
    "Furniture",
    "Electronics"
  ],
  "content": "Household items and boxes",
  "photos": [
    {
      "url": "https://communication-media.cdn.production.monument.io/auctions/photo1.jpg",
      "isPrimary": true,
      "photoType": "UNIT_CONTENTS"
    }
  ],
  "tamperTagId": "TAG-12345",
  "requiresNotice": false
}

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

GL Accounts

ECRI

Journal Entries

Ledger Entries

Rent Changes

Payments

Summary

Auctions

Tenants

User Accounts

Units

Unit Groups

Physical Locks

Move Out

Leads

Tasks

People

Lead Source Options

Notes

Promotions

Webhooks

Headers

Path Parameters

Body

Response