Integrations
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 through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View custom fields (custom_field:read)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: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, custom_field:read, custom_field:write, employments, all:write, all:read)

Request body

OR
OR

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 65 revisions of this API.