Create a custom object type

Platform module

POST/custom-object-typescustomObjectTypes.create

A custom object type with its own API routes at `/objects/{objectKey}`. Creates a custom object type. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.custom_objects.write.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: CustomObjectTypeCreate

customObjectTypes.create: CustomObjectTypeCreate
Field	Type	Required	Description
object_key	string	Yes	Object key used in the route.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
label	string	Yes	Title Case label.Constraints: length 1 to 300
icon	string	Yes	Icon name.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_view	string	No	Default view type.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "object_key": "sponsor_activation",
  "label": "Sponsor Activation",
  "icon": "sparkles",
  "default_view": "table"
}

Response 201: CustomObjectType

customObjectTypes.create: CustomObjectType
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the custom object type.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
object_key	string	Yes	Object key used in the route.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
label	string	Yes	Title Case label.Constraints: length 1 to 300
icon	string	Yes	Icon name.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_view	string	Yes	Default view type.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "object_key": "sponsor_activation",
  "label": "Sponsor Activation",
  "icon": "sparkles",
  "default_view": "table"
}

Code samples

curl -X POST "$XOS_BASE_URL/custom-object-types" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"object_key":"sponsor_activation","label":"Sponsor Activation","icon":"sparkles","default_view":"table"}'

const { data } = await xos.customObjectTypes.create({
    "object_key": "sponsor_activation",
    "label": "Sponsor Activation",
    "icon": "sparkles",
    "default_view": "table"
  });

response = xos.custom_object_types.create({"object_key": "sponsor_activation", "label": "Sponsor Activation", "icon": "sparkles", "default_view": "table"})

xos custom-object-types create --data '{"object_key":"sponsor_activation","label":"Sponsor Activation","icon":"sparkles","default_view":"table"}'