Channel
Authorizations
HTTPRequired
Header parameters
Content-TypestringOptionalExample:
multipart/form-dataBody
namestringOptionalExample:
type: ^[a-zA-Z0-9 \.\-\_]+$
Example channeliconstringOptionalExample:
type: ^[a-zA-Z0-9\-\_]+$ = 'chat'
notecustom_channel_endpointstringOptionalExample:
type: ^[a-zA-Z0-9\.\:\/\-?&=]+$
https://api.myexampleapp.com/omnidesk/api/messagecustom_channel_secretstringOptional
type: string = ''
include_signaturestringOptional
type: boolean = 'false'
Responses
200
Successful response
application/json
post
/api/v2/channel200
Successful response
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample:
type: number
13Body
namestringOptionalExample:
type: ^[a-zA-Z0-9 \.\-\_]+$
Example channeliconstringOptionalExample:
type: ^[a-zA-Z0-9\-\_]+$ = 'chat'
notecustom_channel_endpointstringOptionalExample:
type: ^[a-zA-Z0-9\.\:\/\-?&=]+$
https://api.myexampleapp.com/omnidesk/api/messagecustom_channel_secretstringOptional
type: string = ''
custom_channel_warning_enstringOptional
type: ^[0-9a-zA-Z\-\_\:\;\>\+\(\)\/\!\?\,\.\#\@\$\*\&À-ȕ\' ]+$ = ''
custom_channel_warning_nlstringOptional
type: ^[0-9a-zA-Z\-\_\:\;\>\+\(\)\/\!\?\,\.\#\@\$\*\&À-ȕ\' ]+$ = ''
include_signaturestringOptional
type: boolean = 'false'
custom_channel_available_in_quick_ticketstringOptional
type: boolean = 'false'
Responses
200
Successful response
application/json
put
/api/v2/channel/{id}200
Successful response
Authorizations
HTTPRequired
Header parameters
Content-TypestringOptionalExample:
multipart/form-dataBody
ticketIDstringOptional
type: ^[0-9]+$
channelIDstringOptional
type: ^[0-9]+$
messagestringOptional
type: string
titlestringOptional
type: string=''
toAddressstringOptional
type: string=''
fromAddressstringOptional
type: string=''
userIDstringOptional
type: ^[0-9]+$ = 0
Responses
200
Successful response
application/json
post
/api/v2/channel/customChannelMessage200
Successful response
Last updated