Custom Fields

Create Custom Field Definition

Creates a new custom field definition.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage employments (employments)	-	Manage custom fields (custom_field:write)
Company-scoped access token (assertion)	Manage employments (employments)	-	Manage custom fields (custom_field:write)
Customer API token	Manage employments (employments)	-	Manage custom fields (custom_field:write)

post/v1/custom-fields

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/custom-fields
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: custom_field:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: custom_field:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Request body

Example request

{
  "data_entry_access": "company_admin_only",
  "name": "Internal ID",
  "required": false,
  "type": "string",
  "visibility_scope": "everyone"
}

Response

Success

Example response

{
  "data": {
    "custom_field": {
      "data_entry_access": "company_admin_only",
      "id": "01c0e4d2-f41b-11ed-9d3f-cb3ecccebb58",
      "metadata": {},
      "name": "Internal ID",
      "required": true,
      "type": "string",
      "visibility_scope": "everyone"
    }
  }
}

Changes

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