Log inTry for free
Back to all APIs

Create conversation form

Use this method to create a form.

Please log in to see full path URL. Learn why.
post
/ccaas/2/conversation-forms/forms
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
conversations:manage
Request Body schema:
application/json
collapse all -
title
required
string [ 0 .. 100 ] characters

Form title.

isEnabled
required
boolean

Is form enabled. Mandatory when updating.

isDefault
boolean

Is form default.

fields
required
Array of objects [ 1 .. 2147483647 ] items

Fields attached to a form.

Array
fieldId
required
string
isRequired
required
boolean
conditions
Array of objects
Array
id
string
value
required
string
conditionalFields
required
Array of objects [ 1 .. 2147483647 ] items
Array
fieldId
required
string
isRequired
required
boolean

Responses

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

Request samples

Content type
application/json
Example
Creating form with simple field.

Creating form with simple field.

Copy
 Collapse all
{
  • "title": "Granulation",
  • "isEnabled": true,
  • "fields":
    [
    • {
      • "fieldId": "ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
      • "isRequired": false
      }
    ]
}

Response samples

Content type
application/json
Example
Successful response form with simple field

Successful response form with simple field

Copy
 Collapse all
{
  • "id": "75f57446-1d65-478a-87ed-22d17dc3d077",
  • "title": "Granulation",
  • "isEnabled": true,
  • "isDefault": false,
  • "fields":
    [
    • {
      • "field":
        {
        • "id": "ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
        • "title": "Inquiry",
        • "type": "TEXT",
        • "isEnabled": true,
        • "isDefault": null,
        • "options": [ ],
        • "createdAt": "2021-06-29T10:00:16.692653Z",
        • "updatedAt": "2021-06-29T10:00:16.692654Z",
        • "operators": [ ]
        },
      • "isRequired": false,
      • "conditions": [ ]
      }
    ],
  • "createdAt": "2021-06-29T10:01:11.633649Z",
  • "updatedAt": "2021-06-29T10:01:11.633650Z"
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.

Privacy documentsTerms of use