SMsmartrecruiters
predefined-locations

Create predefined location

Creates new predefined location

post/configuration/predefined-locations

Request

  • Base URL
    https://api.smartrecruiters.com
  • URL
    https://api.smartrecruiters.com/configuration/predefined-locations
  • Auth
    • API key in header x-smarttoken
    • or 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

citystring required

Not blank. No leading and trailing spaces allowed.

countryCodestring required

ISO-3166-1 alpha-2 country code

regionstring
regionAbbrstring

Not blank. No leading and trailing spaces allowed. Region abbreviation, if applicable. E.g. Utah -> UT.

addressstring

Not blank. No leading and trailing spaces allowed.

postalCodestring

Not blank. No leading and trailing spaces allowed.

latnumber

Decimal latitude value

lngnumber

Decimal longitude value

titlestring

User managed Title. If present, value must not be blank and must be unique within the company (case insensitive).

identifierstring

Only alphanumerical characters, dashes, hashes and underscores are allowed. User managed Identifier. If present, value must not be blank and must be unique within the company (case sensitive).

Example request

{
  "city": "Bern",
  "countryCode": "CH",
  "region": "Canton of Bern",
  "regionAbbr": "CH-BE",
  "address": "Kramgasse 49",
  "postalCode": "3011",
  "lat": 46.947807,
  "lng": 7.4474266,
  "title": "Bern Shop #1 (Einstein Haus)",
  "identifier": "BE-Einstein_House-1"
}

Response

Predefined location successfully created

idstring uuid
countrystring
regionstring
regionAbbrstring
countryCodestring
citystring
addressstring
postalCodestring
titlestring
identifierstring
latnumber
lngnumber

Example response

{
  "country": "Switzerland",
  "region": "Canton of Bern",
  "regionAbbr": "CH-BE",
  "countryCode": "CH",
  "city": "Bern",
  "address": "Kramgasse 49",
  "postalCode": "3011",
  "title": "Bern Shop #1 (Einstein Haus)",
  "identifier": "BE-Einstein_House-1",
  "lat": 46.947807,
  "lng": 7.4474266
}

Changes

No recorded changes to this operation across all 1 revision of this API.