Update a policy

put

https://api.premote.io/v1/policies/{id}

Updates a policy’s fields. When countries is provided, replaces its country coverage with that list; when allCountries: true is provided, replaces it with every country.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

number

required

Policy ID.

Body Params

Policy fields to update.

name

object

Policy name, per locale.

daysUnderPolicy

number

daysOfStay

number

Total calendar days the traveler may stay (Aufenthalts-Tage). Must be >= daysUnderPolicy. Defaults to daysUnderPolicy when omitted.

daysTotal

number

gracePeriod

number

countingMode

string

enum

Defaults to CALENDAR_YEAR

Allowed:

countries

array of strings

ISO 3166-1 alpha-2 codes of the destination countries the policy covers. When provided, replaces the whole coverage. Unknown codes are ignored. Cannot be combined with allCountries: true.

countries

allCountries

boolean

When true, the policy covers every country in GET /countries — no need to list them. Replaces the whole coverage, and cannot be combined with a non-empty countries. false changes nothing: to narrow the coverage, send countries. Countries added to the platform later are not covered automatically.

active

boolean

required

resultText

object

Text shown to the traveler when this policy matches their trip, per locale.

crossBorderOnly

boolean

required

When true, trips whose destination equals the traveler’s country of employment are rejected.

cancellationRequiresApproval

boolean

required

deprecated

Superseded by cancellationMode, which carries a third value this cannot express. Still accepted and still written, so an integration built against it keeps working; it is ignored where the two disagree.

cancellationMode

string

enum

required

Defaults to REQUEST_CANCELLATION

Whether the trip owner may cancel outright, must record a request an admin approves, or cannot do either.

Allowed:

tripEditMode

string

enum

required

Defaults to REQUEST_CHANGES

What the trip owner may change on their own trip once it is approved.

Allowed:

Responses

200

Policy updated. Returns no response body.

400

allCountries: true was combined with a non-empty countries list.

404

No policy with this ID exists for the company.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!