omnidesk
  • Ticket
    • Message
    • Using forms
    • Contact forms
  • Customers
    • General
    • API sync on contact
    • CSV import
    • API sync before contact
    • Customer lookup
  • Telephone
    • Callflow
    • Numbers
  • E-mail
  • Users
  • Live chat
    • Livechat chatbot and app integration (backend)
  • Facebook
  • Twitter
  • Survey
    • Push data
  • Statistics
    • Statistics API
  • Raw data - BI
  • Security policy
  • Hosting
  • API docs
    • General
    • Authentication
    • REST
  • API specification
    • Documentation for the Omnidesk API endpoints
    • Chat
    • Customer
    • Email
    • Form
    • Formfield
    • Message
    • Notification
    • Raw
    • Statisticsv2
    • Ticket
    • User
    • View
Powered by GitBook
On this page
  1. API specification

Formfield

PreviousFormNextMessage

All the endpoints that can be called on the Formfield controller.

Each endpoint requires the FORM_CUD permission, except for GET index, which requires the FORM_READ permission.

item

get

Returns this specific form field by ID.

Authorizations
Path parameters
idnumberRequired
Responses
get
GET /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success
No content
  • GETindex
  • POSTindex
  • GETitem
  • PUTitem
  • DELETEitem

index

get

Returns all form fields with optional filters such as search queries, views and result limits.

Authorizations
Query parameters
querystring · min: 1OptionalPattern: ^[0-9a-zA-Z ]+$
itemStartnumberOptionalDefault: 0
itemLimitnumber · max: 9999OptionalDefault: 15
Responses
get
GET /api/v2/formfield HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success
No content

index

post

Creates a new form field.

If you want to add multiple required statuses, simply send an array of the statuses needed.

Authorizations
Body
form_idnumberRequired
titlestring · min: 1Required
input_typestring · enumRequiredPossible values:
field_ordernumberOptional
Responses
post
POST /api/v2/formfield HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 93

{
  "form_id": 1,
  "title": "text",
  "input_type": "text",
  "field_order": 1,
  "required_statuses": [
    "open"
  ]
}
200Success
No content

item

put

Updates this form field.

Identical to POST index, except this one also has an external code parameter.

If you want to add multiple required statuses, simply send an array of the statuses needed.

Authorizations
Path parameters
idnumberRequired
Body
form_idnumberRequired
titlestring · min: 1Required
input_typestring · enumRequiredPossible values:
field_ordernumberOptional
external_codestring · min: 1Optional
Responses
put
PUT /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 116

"form_id=1&title='text'&input_type='text'&field_order=1&external_code='text'&required_statuses=['open']"
200Success
No content

item

delete

Permanently deletes this form field.

Authorizations
Path parameters
idnumberRequired
Body
descriptionstringOptional

Optional parameter if you want to send a description for deletion.

Responses
delete
DELETE /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22

"description='text'"
200Success
No content