Sign in
Space

Update geographic permissions

Replaces the selected countries with the array in the request. Codes outside supported_countries are dropped; if nothing supported remains, the request is rejected with no_supported_countries.

Updating the selection additionally requires that the space is allowed to edit international settings. A space that is not receives 401 even when the token holder is an owner or admin.

Permissions

Authenticate with a Personal access token whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

put/api/space/geographic_permissions

Request body

countriesstring[] required

The ISO 3166-1 alpha-2 country codes to select. The array replaces the current selection. Codes outside supported_countries are dropped, and if nothing supported remains the request is rejected with no_supported_countries.

Example request

{
  "countries": [
    "US"
  ]
}

Response

The request has succeeded.

type'geographic_permission' required

The object type. Always geographic_permission.

countriesstring[] required

The selected ISO 3166-1 alpha-2 country codes.

supported_countriesstring[] required

The ISO 3166-1 alpha-2 country codes that may be selected.

Example response

{
  "type": "geographic_permission",
  "countries": [
    "US",
    "CA"
  ],
  "supported_countries": [
    "US",
    "CA",
    "GB"
  ]
}

Changes

Changed in 1 of the 161 revisions of this API.1

Of the 161 revisions, 3 have a changelog that could not be searched.