Custom Rates

Create a new Custom Rate

post/api/custom-rates

Request

  • Base URL: https://hellosafe.com
  • URL: https://hellosafe.com/api/custom-rates
  • Auth: OAuth 2 (password, token URL /api//openapi-auth)

Query parameters

depthnumber
localestring

Request body

type'paid' required

What kind of rate this is. "paid" = a bought campaign recovering its clicks, kept as margin. Known: paid.

partnerCodestring required

What this rate is keyed on, one record per key: <source>:<campaign>, trimmed and lowercased, e.g. "bing-ads:[pt] seguro de viagem" or "google-ads:23979271611" — the Source and Source Detail pair shown on any subscription from that campaign (Bing sends the campaign name in utm_campaign, Google sends only the numeric gad_campaignid).

upliftBpsnumber required

Points added to the processing fee, in basis points of the premium (2000 = 20 points). Capped at 4706, the ceiling that lets a partner reach a 50% commission. This raises the price the traveller sees, so it is a trade: more margin per sale against some conversion, and the revenues ledger is where that trade is settled.

upliftRetentionPercentagenumber required

Of the uplift collected, the share HelloSafe retains, in percent. 100 = all of it is ours, nothing is paid out. A paid campaign stays at 100, since there is nobody to pay. Frozen on each sale with the uplift, read by the revenues ledger.

activeboolean nullable

Off means this campaign prices at the standard fee, whatever the number says.

syncedAtstring nullable

When the owning system last confirmed this value; a record left unconfirmed for 7 days prices at the standard fee. LEAVE THIS EMPTY unless you want that expiry: no date means the rate holds until someone changes it, a date means the uplift lapses on its own a week later.

labelstring nullable

Free text, internal. The readable campaign name — the only place it appears when the key is a numeric Google campaign id.

deletedAtstring nullable

Response

Custom Rate object

messagestring required

Changes

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