Skip to main content
POST
/
custom_fields
Create custom fields
curl --request POST \
  --url https://api.partoo.co/v2/custom_fields \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data '{
  "name": "Click and collect",
  "type": "BOOLEAN",
  "order": 30,
  "section_id": 6
}'
{
  "id": 42
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Body

application/json
  • Boolean Field
  • Text Field
  • Integer Field
  • Float Field
  • Single Select Field
  • Multiple Select Field
  • Multiple Select Image Field
  • Images Uploader Field

Boolean Custom Field

​
name
string

The name of the custom field

Required string length: 1 - 50
Example:

"Click and collect"

​
type
string

BOOLEAN

Minimum length: 1
Example:

"BOOLEAN"

​
order
integer
default:10

Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, order specifies its position within the custom field section.

Example:

30

​
section_id
integer

Id of the custom field section

Example:

6

Response

OK

​
id
integer

Id of the custom field

Example:

42