Skip to main content
POST
Create a company country

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
company_country
object
required
seed_legacy_defaults
boolean | null

False skips the default country agreements and default forms a new country normally receives, for a caller that creates its own selection. The Japan gaiyo shomen enrollment form is still created where required. Omitted or true keeps the defaults.

expected_revision
string | null

The revision of the company's existing row for this country that the caller loaded. Sent with company_country.entity_id, it assigns that row to the entity instead of creating a second one, and the submitted settings are written only if the row is still at this revision; otherwise nothing is written and the response is 409. Without it, a country the company already has is refused with 422.

Response

object | null

Success

company_country
CompanyCountry · object | null
warnings
object[]

Non-blocking configuration warnings produced by the write.

meta
object | null