---
title: "Create a custom data scope"
method: POST
path: "/configuration/countries/custom-scopes"
tags: ["configuration"]
---

# Create a custom data scope

`POST /configuration/countries/custom-scopes`

## Request

- Base URL: `https://api.smartrecruiters.com`
- URL: `https://api.smartrecruiters.com/configuration/countries/custom-scopes`
- Auth: one of:
  - API key in header `x-smarttoken`
  - OAuth 2
    - Authorization code: `https://www.smartrecruiters.com/identity/oauth/allow`
    - Token URL: `https://api.smartrecruiters.com/identity/oauth/token` scopes: `configuration_manage`

## Request body

- CustomScopeRequest
  - `name` string, required
  - `countryCode` string, required
  - `checkboxRequired` boolean, required
  - `translations` CustomScopeTranslation[], required
    - `language` string, required
    - `label` string, required

## Response `201`

Created custom scope

- CustomScopeResponse
  - `id` string, uuid, required
  - `countryCode` string, required
  - `status` 'ACTIVE' | 'DELETED', required
  - `name` string, required
  - `checkboxRequired` boolean, required
  - `translations` CustomScopeTranslation[], required
    - `language` string, required
    - `label` string, required

## Other responses

- `403`: Forbidden
- `409`: The company account must operate on separated consent model
- `422`: Validation error

---

[API](https://skmtc.dev/smartrecruiters/apis/configuration-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/configuration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/configuration-api/revisions/65491281a1a6?raw)