Create a policy

Creates a new travel or workation policy for the company with the given day allowances and counting mode. Set the destination coverage in the same call with countries, or with allCountries: true to cover every country.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Policy creation data.

name
object
required

Policy name, per locale.

number
required
number
required

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

number
required
number
required
string
enum
required
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
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.

Responses

400

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

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json