Skip to main content
PATCH
/
v1
/
reports
/
{reportId}
Update a report
curl --request PATCH \
  --url https://api.northreports.com/v1/reports/{reportId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "price": 123,
  "beds": 123,
  "baths": 123,
  "sqft": 123,
  "year_built": 123,
  "property_type": "<string>",
  "description": "<string>",
  "status": "<string>",
  "is_draft": true,
  "executive_summary": "<string>",
  "show_comps_on_report": true,
  "show_neighborhood_on_report": true,
  "show_social_media_on_report": true,
  "show_showings_on_report": true,
  "show_agent_insights_on_report": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer north_sk_live_xxxxxxxxxxxx

Path Parameters

reportId
string<uuid>
required

The report ID to update

Body

application/json
address
string
city
string
state
string
zip
string
price
number
beds
integer
baths
number
sqft
integer
year_built
integer
property_type
string
description
string
status
string
is_draft
boolean
executive_summary
string
show_comps_on_report
boolean
show_neighborhood_on_report
boolean
show_social_media_on_report
boolean
show_showings_on_report
boolean
show_agent_insights_on_report
boolean

Response

Report updated successfully

data
object
message
string