Skip to main content
PATCH
Update Portal Offer

Authorizations

Authorization
string
header
required

Conduit API token. Use Authorization: Bearer <token>. Read/write endpoints require a token with write access.

Path Parameters

workspace_id
string
required

Workspace identifier

Minimum string length: 1
id
string
required

Portal offer identifier

Minimum string length: 1

Body

application/json
expected_updated_at
number
required
Required range: x >= 0
name
string
Minimum string length: 1
description
string
price_in_cents
integer
Required range: x >= 0
percent_price
object | null
compare_at_price_in_cents
integer | null
Required range: x >= 0
image_url
string | null
image_attribution
object | null
background_hex
string | null
Pattern: ^#?[0-9a-fA-F]{6}$
category
string | null
kind
enum<string>
Available options:
purchase,
request,
ad

Ad offers only: label of the button that opens link_url, up to 24 characters

highlights
string[] | null
availability
object | null
targeting
object | null
stripe_connection_id
string | null

Stripe account that receives this offer's payments, overriding the workspace's payment routing. Requires Manage Portal Payments.

Minimum string length: 1
price_unit
enum<string> | null

per_night and per_day multiply the price by the nights or days the guest selects

Available options:
per_stay,
per_night,
per_day
charge_every_night
boolean

per_night offers only: charge every night of the stay instead of letting the guest pick nights

date_selection
enum<string> | null

Which dates of the stay the guest picks. per_night and per_day offers always use a range.

Available options:
single,
multiple,
range
max_per_order
integer | null
Required range: 1 <= x <= 20
questions
object[] | null

Questions the guest answers when ordering. Replaces the full list.

option_groups
object[] | null

Up to 3 groups of up to 12 options. Option prices add to price_in_cents. Replaces the full list.

combinations_enabled
boolean

Prices each combination of single-choice options separately. Requires variants.

variants
object[] | null

Sellable combinations when combinations_enabled is true. Each price replaces the base price. Replaces the full list.

Response

Update Portal Offer

data
object
required