Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
CustomResources > Schema

Creates a Schema

Creates a Schema

post/api/2026-07-01/resources/custom_resources/schemas

Request body

namestring required

Schema name

company_idstring required

Company identifier where this schema belongs

effective_at_idstring

Custom field identifier

hiddenboolean required

Manages visibility of the schema

positioninteger

Schema position within employee profile

usage_group_slugstring

Schema slug

Example request

{
  "name": "Company Offsite",
  "company_id": "2",
  "effective_at_id": "1",
  "position": 1,
  "usage_group_slug": "company_offsite"
}

Response

CREATED

idstring required

Schema identifier

namestring required

Schema name

company_idstring required

Company identifier where this schema belongs

hiddenboolean required

Manages visibility of the schema

positioninteger

Schema position within employee profile

Example response

{
  "id": "1",
  "name": "Company Offsite",
  "company_id": "2",
  "position": 1
}