Skip to main content

Countries Model

A country provides geographic grouping for cities and country-scoped metadata.

Operations​

ActionMethodResource
ListGET/countries
FindGET/countries/{country}
CreatePOST/countries
UpdatePUT/countries/{country}
DeleteDELETE/countries/{country}

Shared concepts​

  • name identifies the country and is required on create.
  • code stores an optional country code.
  • enabled controls the country's status.
  • cities represents the country's city collection.
  • metafields and expanded metadata provide country-specific extensions when requested.

The list operation does not require operation-level authentication. Find and mutation operations require role levels 0 and 1.

Field presence varies by operation and requested relations. Treat this as a conceptual guide, not a complete schema.