INinfobip
customer-engagement
conversations
web-forms

Create web form

Use this method to create a new web form.

post/ccaas/1/web-forms

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

namestring

Web Form name.

channel'SMS' | 'VIBER' | 'FACEBOOK_MESSENGER' | 'WHATSAPP' | 'RCS' | 'UNKNOWN' | 'EMAIL' | 'MULTICHANNEL' | 'NO_CHANNEL' | 'LIVE_CHAT' | 'UNUSED' | 'VOICE' | 'VIDEO' | 'APPLE_BUSINESS_CHAT' | 'LINE' | 'GOOGLE_BUSINESS_MESSAGES' | 'TELEGRAM' | 'CALLS' | 'INTERNAL' | 'FACEBOOK_POST' | 'INSTAGRAM_POST' | 'TWITTER_POST' | 'VIBER_BOT' | 'INSTAGRAM_MESSAGING' | 'GOOGLE_PLAY' | 'KAKAO_SANGDAM' | 'TWITTER_DM' | 'WHATSAPP_CALLS' | 'VIBER_CALLS' | 'OPEN_CHANNEL' | 'TIKTOK' | 'ZALO'

Communication channel.

destinationstring

Web Form destination.

urlstring

Web Form URL.

enabledboolean

Web Form enable/disable toggle.

tagIdsstring[]

List of tag Ids used on the Web Form.

Example request

{
  "name": "Test WebForm",
  "channel": "EMAIL",
  "destination": "destination@email.test",
  "url": "/ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post",
  "enabled": true
}

Response

OK

idstring

Web Form Id.

namestring

Web Form name.

channel'SMS' | 'VIBER' | 'FACEBOOK_MESSENGER' | 'WHATSAPP' | 'RCS' | 'UNKNOWN' | 'EMAIL' | 'MULTICHANNEL' | 'NO_CHANNEL' | 'LIVE_CHAT' | 'UNUSED' | 'VOICE' | 'VIDEO' | 'APPLE_BUSINESS_CHAT' | 'LINE' | 'GOOGLE_BUSINESS_MESSAGES' | 'TELEGRAM' | 'CALLS' | 'INTERNAL' | 'FACEBOOK_POST' | 'INSTAGRAM_POST' | 'TWITTER_POST' | 'VIBER_BOT' | 'INSTAGRAM_MESSAGING' | 'GOOGLE_PLAY' | 'KAKAO_SANGDAM' | 'TWITTER_DM' | 'WHATSAPP_CALLS' | 'VIBER_CALLS' | 'OPEN_CHANNEL' | 'TIKTOK' | 'ZALO'

Communication channel.

destinationstring

Web Form destination.

urlstring

Web Form URL.

enabledboolean

Web Form enable/disable toggle.

tagIdsstring[]

List of tag Ids used on the Web Form.

createdAtstring date-time

Time stamp when Web Form is created.

updatedAtstring date-time

Time stamp when Web Form was updated.

Example response

{
  "id": "7646c2ff-916d-46f1-9c53-5273476ed505",
  "name": "Test WebForm",
  "channel": "EMAIL",
  "destination": "destination@email.test",
  "url": "/ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post",
  "enabled": true,
  "createdAt": "2023-11-01T00:00:00.000+00:00",
  "updatedAt": "2023-11-01T00:00:00.000+00:00",
  "tagIds": [
    "2423d4c7-23da-422a-9f15-ca08006051ea",
    "2664c7c3-f546-4073-a961-b94aed465ee8"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.