v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Custom Fields

Create custom fields

This endpoint enables you to create custom fields for your organization. You can specify the field name, description, slug, type-specific constraints, order, and optionally assign it to a section. PROVIDER users can pass org_id to create custom fields for a managed organization.

post/custom_fields

Query parameters

org_idinteger

Organization ID. Only PROVIDER users can specify a different organization. If not provided, defaults to your own organization.

Request body

OR
OR
OR
OR
OR
OR
OR

Example request

{
  "name": "Click and collect",
  "description": "Whether the business offers click and collect service",
  "type": "BOOLEAN",
  "slug": "click-and-collect",
  "order": 30,
  "section_id": 6
}

Response

OK

custom_field_idinteger

Id of the custom field

Example response

{
  "custom_field_id": 42
}