LiveChat

LiveChat

Update a post-chat form

put

Updates an existing post-chat form configuration and its fields

Authorizations

Bearer

Path parameters

workspacestring · uuidRequired

Workspace ID

idintegerRequired

Post-chat form ID

Body

application/json

enabledbooleanOptional

Enable/disable the form

Example: true

titlestringOptional

Form title

Example: Welcome to our support

descriptionstringOptional

Form description

Example: Please fill out this form to help us assist you better

submit_button_textstringOptional

Text for the submit button

Example: Start Chatting

require_fieldsbooleanOptional

Whether all fields are required

Example: true

delete_field_idsinteger[]Optional

IDs of fields to delete

Example: 3

Responses

200

Success

application/json

401

Unauthenticated

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Validation Error

application/json

500

Server Error

application/json

put

/api/workspaces/{workspace}/livechat/post-chat-forms/{id}

HTTPcURLJavaScriptPython

PUT /api/workspaces/{workspace}/livechat/post-chat-forms/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 425

{
  "enabled": true,
  "title": "Welcome to our support",
  "description": "Please fill out this form to help us assist you better",
  "submit_button_text": "Start Chatting",
  "require_fields": true,
  "fields": [
    {
      "id": 1,
      "type": "text",
      "name": "full_name",
      "label": "Full Name",
      "placeholder": "Enter your full name",
      "required": true,
      "enabled": true,
      "options": [
        {
          "value": "option1",
          "label": "Option 1"
        }
      ],
      "validation": "null",
      "order": 0
    }
  ],
  "delete_field_ids": [
    3
  ]
}

{
  "message": "Post-chat form updated successfully",
  "post_chat_form": {
    "id": 1,
    "channel_id": "abc123",
    "widget_id": "xyz456",
    "enabled": true,
    "title": "Welcome to our support",
    "description": "Please fill out this form to help us assist you better",
    "submit_button_text": "Start Chatting",
    "require_fields": true,
    "fields": [
      {
        "id": 1,
        "post_chat_form_id": 1,
        "type": "text",
        "name": "full_name",
        "label": "Full Name",
        "placeholder": "Enter your full name",
        "required": true,
        "enabled": true,
        "options": "null",
        "validation": "null",
        "order": 0,
        "created_at": "2023-01-01T00:00:00.000000Z",
        "updated_at": "2023-01-01T00:00:00.000000Z"
      }
    ],
    "created_at": "2023-01-01T00:00:00.000000Z",
    "updated_at": "2023-01-01T00:00:00.000000Z"
  }
}

Update a pre-chat form

put

Updates an existing pre-chat form configuration and its fields

Authorizations

Bearer

Path parameters

workspacestring · uuidRequired

Workspace ID

idintegerRequired

Pre-chat form ID

Body

application/json

enabledbooleanOptional

Enable/disable the form

Example: true

titlestringOptional

Form title

Example: Welcome to our support

descriptionstringOptional

Form description

Example: Please fill out this form to help us assist you better

submit_button_textstringOptional

Text for the submit button

Example: Start Chatting

require_fieldsbooleanOptional

Whether all fields are required

Example: true

delete_field_idsinteger[]Optional

IDs of fields to delete

Example: 3

Responses

200

Success

application/json

401

Unauthenticated

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Validation Error

application/json

500

Server Error

application/json

put

/api/workspaces/{workspace}/livechat/pre-chat-forms/{id}

HTTPcURLJavaScriptPython

PUT /api/workspaces/{workspace}/livechat/pre-chat-forms/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 427

{
  "enabled": true,
  "title": "Welcome to our support",
  "description": "Please fill out this form to help us assist you better",
  "submit_button_text": "Start Chatting",
  "require_fields": true,
  "fields": [
    {
      "id": 1,
      "type": "text",
      "name": "full_name",
      "label": "Full Name",
      "placeholder": "Enter your full name",
      "required": true,
      "enabled": true,
      "options": "[{'value':'option1','label':'Option 1'}]",
      "validation": "null",
      "order": 0
    }
  ],
  "delete_field_ids": [
    3
  ]
}

{
  "message": "Pre-chat form updated successfully",
  "pre_chat_form": {
    "id": 1,
    "channel_id": "abc123",
    "widget_id": "xyz456",
    "enabled": true,
    "title": "Welcome to our support",
    "description": "Please fill out this form to help us assist you better",
    "submit_button_text": "Start Chatting",
    "require_fields": true,
    "fields": [
      {
        "id": 1,
        "pre_chat_form_id": 1,
        "type": "text",
        "name": "full_name",
        "label": "Full Name",
        "placeholder": "Enter your full name",
        "required": true,
        "enabled": true,
        "options": "null",
        "validation": "null",
        "order": 0,
        "created_at": "2023-01-01T00:00:00.000000Z",
        "updated_at": "2023-01-01T00:00:00.000000Z"
      }
    ],
    "created_at": "2023-01-01T00:00:00.000000Z",
    "updated_at": "2023-01-01T00:00:00.000000Z"
  }
}