> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sonderplan.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create Custom Field
>
`WRITE` access to the `ADMIN` module is required to access this endpoint
## OpenAPI
````yaml /api-reference/openapi-mintlify.yaml post /v2/custom-field
openapi: 3.0.0
info:
title: Sonderplan API
description: >
## Overview
You can use our REST API to securely access and modify the data within your
Sonderplan account. This includes all the information within your bookings,
projects and invoices that you can use to import / export data or create
integrations with other systems and software that you use
### General Notes
#### Specifying Fields
The Sonderplan REST API allows you to specify a comma delimited string of
exactly which fields are returned, using the `fields` parameter. Using this
parameter has several advantages including:
1. In future API versions we may change which fields are presented by
default, so explicitly specifying the fields required overrides the defaults
and ensure the fields are served
2. Limiting fields reduces the processing we need to do and allows us to
send you the data faster
3. Some search filters only work if the field you are searching is added to
the `fields` parameter.
Example:
```
fields=id,name,start,duration_min
```
### Applying Filters
The Query Parameters section in each endpoint shows you special options that
can be added to your request to customise the response we send you.
Most endpoints offer the following query params:
| Query Parameter |
Description |
|-----------------|----------------------------------------------------------------|
| `fields` | Only send the specified
fields |
| `id` | Specify one or more ids (comma seperated) of records to
return |
| `limit` | The maximum number of records to
return |
| `page` | The page number of records to
return |
| `order_asc` | Specify which field should be used to sort records
`ascending` |
| `order_desc` | Specify which field should be used to sort records
`descending` |
In addition to the standard `id` param, you can also specify most other
fields as a query parameter, useful for performing searching and filtering
of records.
For example, you can specify `repeat_master_id=` to
return all repeat children of that booking.
#### Other Query Params
Refer to the specific API endpoint documentation to see which other query
params can be used.
For example, some endpoints allow specifying `updated_after=` which will only send added, edited and even deleted records that
were modified after the unix timestamp.
#### Applying multiple filters
By default, multiple filters are chained together using **OR** (either
filter can be true and it will be included). You can change this behaviour
by specifying `filter_operator=AND`, so each filter must be true to be
included.
#### Filtering by Custom Field Values
For modules that include custom fields, you can search by the value of a
custom field by adding the `custom_field_` to the URL query
parameters. You **must** also specify the custom field in the `fields`
parameter.
```
GET
https://api.sonderplan.com/v2/booking?fields=id,name,custom_field_238938&custom_field_238938=Offline
```
This will return custom fields that contain the word 'Offline'.
contact:
email: info@sonderplan.com
version: '2.0'
servers:
- url: https://api.sonderplan.com
description: Production Server
security: []
tags:
- name: Booking
description: Booking related operations
- name: Project
description: Project related operations
- name: Resource
description: Resource related operations
- name: Contact
description: Contact related operations
- name: Quote
description: Quote related operations
- name: Invoice
description: Invoice related operations
- name: Invoice Template
description: Invoice template related operations
- name: Billable Item
description: Billable item related operations
- name: Rate Scheme
description: Rate scheme related operations
- name: Tax
description: Tax related operations
- name: Workspace
description: Workspace (formerly Schedule) related operations
- name: User
description: User related operations
- name: Group
description: Group related operations
- name: Status
description: Status related operations
- name: Custom Field
description: Custom field related operations
- name: Calendar Subscription
description: Calendar Subscription Import related operations
- name: Time Entry
description: Time Entry related operations
- name: Time Activity
description: Time Activity related operations
paths:
/v2/custom-field:
post:
tags:
- Custom Field
summary: Create Custom Field
description: >-
`WRITE` access to the `ADMIN` module is required to access this
endpoint
operationId: 5867b4d677be1ac9df09add89a1828d9
requestBody:
description: Custom Field object that needs to be added
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CustomField'
- required:
- name
- type
- module
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
$ref: '#/components/schemas/success'
'401':
description: Authorization information is missing or invalid
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/notFound'
security:
- bearer: []
components:
schemas:
CustomField:
title: Custom Field Model
description: The default custom field schema
type: object
allOf:
- properties:
id:
description: Automatically generated custom field id
type: integer
readOnly: true
example: 8942
name:
description: Name of the custom field
type: string
example: Booking Type
description:
description: >-
Description of the custom field, shown in the UI at the help
icon
type: string
example: Select the type of booking
type:
description: The type of the custom field
type: string
enum:
- text
- textarea
- select
- number
- date
- datetime
example: select
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption'
module:
description: The module that this custom field is linked to
type: string
enum:
- booking
- project
- people
- organization
- quote
- invoice
- quote_invoice
- billable_item
example: booking
order:
description: >-
Relative order id of this field in relation to other custom
fields in the same module
type: integer
example: 3
required:
description: Marks this field as required, enforced by the API and UI
type: boolean
example: true
update_key:
description: The update key to pass back when updating this field
type: string
example: '2_1_8942'
deprecated: true
type: object
- $ref: '#/components/schemas/commonModelMeta'
success:
title: Success Response
properties:
success:
properties:
id:
type: integer
example: 1
type: object
type: object
notFound:
title: Not Found Response
description: Class OpenApi
properties:
error:
properties:
code:
description: The HTTP error code
type: integer
example: '404'
message:
description: More detail on the error encountered
type: string
example: Requested resource was not found
type: object
type: object
CustomFieldOption:
title: Custom Field Option Model
description: The default custom field option schema
properties:
id:
description: The ID of the custom field option
type: string
example: '4934'
name:
description: The name of the custom field option
type: string
example: Video Editing
order:
description: The order of the custom field option
type: string
example: '2'
type: object
commonModelMeta:
title: Common Meta Model
properties:
created_id:
description: The unique ID of the person (user) who created this record
type: integer
readOnly: true
example: 3
created:
description: The UNIX time value of the creation time
type: integer
readOnly: true
example: 1388552400
updated_id:
description: The unique ID of the person (user) who last updated this record
type: integer
readOnly: true
example: 3
updated:
description: The UNIX time value of the last update
type: integer
readOnly: true
example: 1388552400
type: object
securitySchemes:
bearer:
type: http
scheme: bearer
````