API ReferenceCustomer APINudges

Accept a nudge

Accepts a price nudge for a single listing, updating the listing's price to the nudge-recommended value and marking the nudge as accepted. Requires write permission on the listing. Sub-users/team-users without write permission receive a 403 response. The endpoint verifies the nudge is still the latest pending recommendation for that listing and nudge type; if a newer nudge exists, a 409 Conflict is returned.

Headers

X-API-KeystringRequired
API key for Customer API authentication.

Request

This endpoint expects an object.
nudge_idstringRequiredformat: "uuid"
UUID of the nudge to accept
listing_idstringRequired
Listing ID the nudge applies to
pmsstringRequired
PMS name for the listing
update_childrenbooleanOptionalDefaults to false
When true, propagate the price change to child listings

Response

Nudge accepted successfully
nudge_idstringOptionalformat: "uuid"
listing_idstringOptional
pms_namestringOptional
nudge_typeenumOptional
statusstringOptional
applied_valueintegerOptional
The price value that was applied to the listing
update_childrenbooleanOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error