Skip to product menu
Skip to main content

Create an App

Description

You can use this API to create an app.

Request Payload

  • name : To specify the name of the app
  • departments : To specify the departments with which the App is going to be mapped .
  • description : To specify the description of the app
  • business_hours : To enable the business hours option by acknowledging your availability and give your customers a better sense of when they can expect a personal response to their chat requests. To know more, click here. (Values: true/false)
  • privacy : To enable privacy by implementing the GDPR options. To know more, Click here. (Values: true/false)

OAuth Scope:

apps.CREATE

URL

Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screen name}/apps

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylkerinc/apps

Payload

Copied{
  "name": "zylkerinc",
  "business_hours": false,
  "privacy": false,
  "description": {},
  "departments": [
    "46000000000017"
  ]
}

Success Response

Copied{
  "url": "/api/v2/zylkerinc/apps",
  "object": "app",
  "data": {
    "reply_time": "0",
    "modified_time": "1570686177009",
    "view_conversation": true,
    "link_content": "",
    "waiting_time": "60",
    "created_time": "1570686175719",
    "button_text": {
      "text2": "",
      "text1": ""
    },
    "enabled": true,
    "unique_name": "zylkerinc",
    "name": "zylkerinc",
    "contact": {
      "address": "",
      "enabled": true,
      "email": "",
      "name": "",
      "phonenumber": ""
    },
    "description": {},
    "link_url": "",
    "notify_cookies": {
      "url": "",
      "code": "1"
    },
    "hide_when_offline": false,
    "mail_transcript": true,
    "offline_content": {
      "sub_header": "",
      "action": "",
      "header": ""
    },
    "language": "default",
    "creator": {
      "name": "patricia",
      "id": "46000000000005"
    },
    "share_screen": true,
    "seasonaltheme_enabled": false,
    "color": "#0066cc",
    "widget_type": "float",
    "notify_terms": "1",
    "logo_url": "",
    "share_file": true,
    "online_content": {
      "sub_header": "",
      "action": "",
      "header": ""
    },
    "business_hours": false,
    "id": "46000000053001",
    "show_emojis": true,
    "font": "Proxima Nova",
    "departments": [
      {
        "46000000000017": "Marketing"
      }
    ],
    "channels": {
      "website": {
        "faq": 1,
        "chat": 1,
        "enabled": true,
        "proactive": 1,
        "call": 1
      },
      "emailsignature": {
        "faq": 1,
        "chat": 1,
        "enabled": true,
        "proactive": 1,
        "call": 1
      }
    },
    "widgetcode": "52d275f1b450513bb93093c194a70929dd37b5afeef0ad02b8f95c5a7a6d632d",
    "banner_content": "",
    "privacy": false
  }
}