Offers

Update a Offer

patch/api/offers/{id}

Request

  • Base URL: https://hellosafe.com
  • URL: https://hellosafe.com/api/offers/{id}
  • Auth: OAuth 2 (password, token URL /api//openapi-auth)

Request body

internalNamestring
namestring
insurerstring

ID of the insurers

masterVisibility'public' | 'hidden'
visibility'public' | 'hidden' nullable
partner'Heymondo' | 'AVA' | 'AssurTravel' | 'AssurTravelV2' | 'ACS' | 'Yupwego' | 'Chapka' | 'Neat' | 'MondialCare' | 'Manual' | 'Assurever' | 'LeadGeneration' | 'Sonomad'
cmsPartnerstring

ID of the partners

cmsPartnerNamestring nullable
commissionRatenumber nullable

Optional. Overrides the partner brokerage rate for brokerage revenue on this offer. Leave empty to use the partner default (or 20% if the partner has none).

ipidstring

ID of the media

cgvstring

ID of the media

categoriesstring

ID of the categories

isArchivedboolean nullable

Use the Archive button (top right) to archive or unarchive this offer.

iconstring

ID of the offer-icons

topBannerstring nullable

Highlight shown as a violet pill on top of the offer card on the results page, in the same place as the green "Recommended for you" badge. When the offer is also the recommended one, both pills show side by side on desktop and take turns on mobile. Keep it very short (a few words, e.g. "Best seller", "-10% until 31/12"); long text is truncated. Leave empty for no pill.

yesListstring nullable
noListstring nullable
remarksstring nullable

Write any remarks like doc uncertainties, future reminders etc.

webhookUrlstring nullable

Partner endpoint that will be POSTed to when a lead is captured for this offer.

suffix'' | 'perMonth' | 'perYear' | 'perDay' nullable

Displayed at the end of the offer. Max 10 characters.

startingPricenumber nullable

Starting price in cent with the currency set in the settings.

deletedAtstring nullable
_status'draft' | 'published' nullable

Response

Offer object

idstring required
internalNamestring required
namestring required
masterVisibility'public' | 'hidden' required
visibility'public' | 'hidden' nullable
partner'Heymondo' | 'AVA' | 'AssurTravel' | 'AssurTravelV2' | 'ACS' | 'Yupwego' | 'Chapka' | 'Neat' | 'MondialCare' | 'Manual' | 'Assurever' | 'LeadGeneration' | 'Sonomad' required
cmsPartnerNamestring nullable
commissionRatenumber nullable

Optional. Overrides the partner brokerage rate for brokerage revenue on this offer. Leave empty to use the partner default (or 20% if the partner has none).

isArchivedboolean nullable

Use the Archive button (top right) to archive or unarchive this offer.

topBannerstring nullable

Highlight shown as a violet pill on top of the offer card on the results page, in the same place as the green "Recommended for you" badge. When the offer is also the recommended one, both pills show side by side on desktop and take turns on mobile. Keep it very short (a few words, e.g. "Best seller", "-10% until 31/12"); long text is truncated. Leave empty for no pill.

yesListstring nullable
noListstring nullable
remarksstring nullable

Write any remarks like doc uncertainties, future reminders etc.

webhookUrlstring nullable

Partner endpoint that will be POSTed to when a lead is captured for this offer.

suffix'' | 'perMonth' | 'perYear' | 'perDay' nullable

Displayed at the end of the offer. Max 10 characters.

startingPricenumber nullable

Starting price in cent with the currency set in the settings.

updatedAtstring required
createdAtstring required
deletedAtstring nullable
_status'draft' | 'published' nullable

Changes

No recorded changes to this operation across all 1 revision of this API.