Quriobot API
Core Quriobot API based on OpenAPI 2.0.
Learn more
here.
Version: 0.0.1
BasePath:
Terms & Conditions
https://quriobot.com/terms
Access
- APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
- APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
[ Jump to Models ]
Table of Contents
Up
post /0.0.1/backoffice/agents
create backoffice_agent (backofficeAgentCreate)
Create agent
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Agent payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent+jsonapplication/vnd.goa.error
Responses
201
Object created
Agent
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/agents/{id}
delete backoffice_agent (backofficeAgentDelete)
Path parameters
id (required)
Path Parameter — Agent ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/agents/list
list backoffice_agent (backofficeAgentList)
Retrieve all agents.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Agent collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Agent_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/agents/{id}
show backoffice_agent (backofficeAgentShow)
Get agent
Path parameters
id (required)
Path Parameter — Agent ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent+jsonapplication/vnd.goa.error
Responses
200
OK
Agent
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/agents/{id}
update backoffice_agent (backofficeAgentUpdate)
Change agent
Path parameters
id (required)
Path Parameter — Agent ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Agent payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent+jsonapplication/vnd.goa.error
Responses
200
OK
Agent
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/agent_groups
create backoffice_agent_group (backofficeAgentGroupCreate)
Create agent group
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Agent group payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent_group+jsonapplication/vnd.goa.error
Responses
201
Object created
Agent_group
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/agent_groups/{id}/members
create_member backoffice_agent_group (backofficeAgentGroupCreateMember)
Create agent group member
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Agent group member payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/agent_groups/{id}
delete backoffice_agent_group (backofficeAgentGroupDelete)
Path parameters
id (required)
Path Parameter — Agent group ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/agent_groups/{id}/members
delete_member backoffice_agent_group (backofficeAgentGroupDeleteMember)
Delete agent group members
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Agent group member payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/agent_groups/list
list backoffice_agent_group (backofficeAgentGroupList)
Retrieve all agents.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Agent group collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent_group_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Agent_group_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/agent_groups/{id}
show backoffice_agent_group (backofficeAgentGroupShow)
Get agent group
Path parameters
id (required)
Path Parameter — Agent group ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent_group+jsonapplication/vnd.goa.error
Responses
200
OK
Agent_group
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/agent_groups/{id}
update backoffice_agent_group (backofficeAgentGroupUpdate)
Change agent group
Path parameters
id (required)
Path Parameter — Agent group ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Agent group payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent_group+jsonapplication/vnd.goa.error
Responses
200
OK
Agent_group
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/auth/confirm_password_reset
confirm_password_reset backoffice_auth (backofficeAuthConfirmPasswordReset)
Confirm a password reset.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user password reset confirmation payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.authorized+jsonapplication/vnd.goa.error
Responses
200
OK
Authorized
400
Bad Request
error
Up
post /0.0.1/backoffice/auth/extend
extend backoffice_auth (backofficeAuthExtend)
Backoffice extend auth token
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.authorized+jsonapplication/vnd.goa.error
Responses
200
OK
Authorized
400
Bad Request
error
401
Unauthorized
Up
post /0.0.1/backoffice/login
login backoffice_auth (backofficeAuthLogin)
Backoffice login
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.authorized+jsonapplication/vnd.goa.error
Responses
200
OK
Authorized
400
Bad Request
error
401
Unauthorized
Up
get /0.0.1/backoffice/login_oauth_callback/{provider}
login_oauth_callback backoffice_auth (backofficeAuthLoginOauthCallback)
Backoffice login oauth callback
Path parameters
provider (required)
Path Parameter — OAauth provider name
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
302
Redirect
400
Bad Request
error
401
Unauthorized
Up
post /0.0.1/backoffice/login_oauth_callback/confirm
login_oauth_confirm backoffice_auth (backofficeAuthLoginOauthConfirm)
Confirm backoffice oauth user registration
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A login oauth callback confirm payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.authorized+jsonapplication/vnd.goa.error
Responses
200
OK
Authorized
400
Bad Request
error
Up
get /0.0.1/backoffice/login_oauth_request/{provider}/{recaptcha_response}
login_oauth_request backoffice_auth (backofficeAuthLoginOauthRequest)
Backoffice login oauth request
Path parameters
provider (required)
Path Parameter — OAauth provider name
recaptcha_response (required)
Path Parameter — Recaptcha response
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice oauth login payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
302
Redirect
400
Bad Request
error
401
Unauthorized
Up
post /0.0.1/backoffice/login_token
login_token backoffice_auth (backofficeAuthLoginToken)
Backoffice login by token
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.authorized+jsonapplication/vnd.goa.error
Responses
200
OK
Authorized
400
Bad Request
error
401
Unauthorized
Up
post /0.0.1/backoffice/logout
logout backoffice_auth (backofficeAuthLogout)
Backoffice logout
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
401
Unauthorized
Up
get /0.0.1/backoffice/recaptcha
recaptcha backoffice_auth (backofficeAuthRecaptcha)
Recaptcha for login
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.recaptcha+json
Responses
200
OK
Recaptcha
Up
post /0.0.1/backoffice/auth/request_password_reset
request_password_reset backoffice_auth (backofficeAuthRequestPasswordReset)
Request a password reset.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user password reset request payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/backoffice/autocomplete/{name}
list backoffice_autocomplete (backofficeAutocompleteList)
List autocomplete items
Path parameters
name (required)
Path Parameter — Autocomplete entity name
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Auto complete item collection payload
Request headers
Query parameters
variant (optional)
Query Parameter — Autocomplete entity variant
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.autocomplete_item_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Autocomplete_item_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/autocomplete/{name}/{variant}
list backoffice_autocomplete (backofficeAutocompleteList1)
List autocomplete items
Path parameters
name (required)
Path Parameter — Autocomplete entity name
variant (required)
Path Parameter — Autocomplete entity variant
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Auto complete item collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.autocomplete_item_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Autocomplete_item_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bots/{id}/channels/{channelID}/configure
configure_channel backoffice_bot (backofficeBotConfigureChannel)
Configure bot channel.
Path parameters
channelID (required)
Path Parameter — Bot channel ID
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_channel_config+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_channel_config
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots
create backoffice_bot (backofficeBotCreate)
Create new bot
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
201
Object created
Bot
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/batch_updates
create_batch_update backoffice_bot (backofficeBotCreateBatchUpdate)
Create bot batch update.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot batch update payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_batch_update+jsonapplication/vnd.goa.error
Responses
201
Object created
Bot_batch_update
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/{id}/channels
create_channel backoffice_bot (backofficeBotCreateChannel)
Create bot channel.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_channel+jsonapplication/vnd.goa.error
Responses
201
Object created
Bot_channel
400
Bad Request
error
403
Forbidden
Up
delete /0.0.1/backoffice/bots/{id}
delete backoffice_bot (backofficeBotDelete)
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/bots/batch_updates
delete_batch_update backoffice_bot (backofficeBotDeleteBatchUpdate)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot batch update collection payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/bots/{id}/channels/{channelID}
delete_channel backoffice_bot (backofficeBotDeleteChannel)
Delete bot channel.
Path parameters
channelID (required)
Path Parameter — Bot channel ID
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/bots/{id}/reporting_token
delete_reporting_token backoffice_bot (backofficeBotDeleteReportingToken)
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
BotReporting
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/bots/responses
delete_responses backoffice_bot (backofficeBotDeleteResponses)
Delete bot responses.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot response delete payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/reports/feedback/download
download_feedback_report backoffice_bot (backofficeBotDownloadFeedbackReport)
Download bot feedback report.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot feedback report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/list/download
download_list backoffice_bot (backofficeBotDownloadList)
Download bot list.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
429
Too many requests
error
Up
post /0.0.1/backoffice/bots/responses/download
download_responses backoffice_bot (backofficeBotDownloadResponses)
Retrieve bot responses.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot response collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/bots/{id}/export/{format}
export backoffice_bot (backofficeBotExport)
Export the bot with given id.
Path parameters
format (required)
Path Parameter — Format
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/{id}/reporting_token
generate_reporting_token backoffice_bot (backofficeBotGenerateReportingToken)
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot reporting token payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
BotReporting
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/{id}/reporting_token/get
get_reporting_token backoffice_bot (backofficeBotGetReportingToken)
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot reporting token payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
BotReporting
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/{id}/channels/{channelID}/launch
launch_channel backoffice_bot (backofficeBotLaunchChannel)
Launch bot channel.
Path parameters
channelID (required)
Path Parameter — Bot channel ID
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_channel+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_channel
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/list
list backoffice_bot (backofficeBotList)
Retrieve all questionnaires.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/batch_updates/list
list_batch_update backoffice_bot (backofficeBotListBatchUpdate)
Retrieve bot batch updates.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot batch update collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_batch_update_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_batch_update_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/channels/list
list_channel backoffice_bot (backofficeBotListChannel)
Retrieve bot channels.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot channel collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_channel_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_channel_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/batch_updates/{id}/prepare
prepare_batch_update backoffice_bot (backofficeBotPrepareBatchUpdate)
Prepare bot batch update.
Path parameters
id (required)
Path Parameter — Bot batch update ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_batch_update+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_batch_update
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/preview
preview backoffice_bot (backofficeBotPreview)
Bot preview.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot preview payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
BotPreview
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/bots/{id}/channels/{channelID}/preview
preview_channel backoffice_bot (backofficeBotPreviewChannel)
Preview bot channel.
Path parameters
channelID (required)
Path Parameter — Bot channel ID
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_channel_preview+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_channel_preview
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/batch_updates/{id}/process
process_batch_update backoffice_bot (backofficeBotProcessBatchUpdate)
Process bot batch update.
Path parameters
id (required)
Path Parameter — Bot batch update ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/{id}/reindex
reindex backoffice_bot (backofficeBotReindex)
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bots/{id}
show backoffice_bot (backofficeBotShow)
Retrieve questionnaire with given id.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
Bot
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bots/batch_updates/{id}
show_batch_update backoffice_bot (backofficeBotShowBatchUpdate)
Show bot batch update.
Path parameters
id (required)
Path Parameter — Bot batch update ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_batch_update+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_batch_update
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bots/{id}/channels/{channelID}
show_channel backoffice_bot (backofficeBotShowChannel)
Show bot channel.
Path parameters
channelID (required)
Path Parameter — Bot channel ID
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_channel+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_channel
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bots/list/download/{downloadID}
show_download_list backoffice_bot (backofficeBotShowDownloadList)
Retrieve bot list download.
Path parameters
downloadID (required)
Path Parameter — Download ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bots/responses/download/{downloadID}
show_download_responses backoffice_bot (backofficeBotShowDownloadResponses)
Retrieve bot responses download.
Path parameters
downloadID (required)
Path Parameter — Download ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/{id}/reports/dropoff
show_dropoff_report backoffice_bot (backofficeBotShowDropoffReport)
Retrieve bot drop off report.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot drop off report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_drop_off_report+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_drop_off_report
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/reports/feedback
show_feedback_report backoffice_bot (backofficeBotShowFeedbackReport)
Retrieve bot feedback report.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot feedback report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_feedback_report+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_feedback_report
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/reports/funnel
show_funnel_report backoffice_bot (backofficeBotShowFunnelReport)
Retrieve bot funnel report.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot funnel report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_funnel_report+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_funnel_report
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/reports/interactive
show_interactive_report backoffice_bot (backofficeBotShowInteractiveReport)
Retrieve bot interactive report.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot interactive report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_interactive_report+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_interactive_report
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/reports/location
show_location_report backoffice_bot (backofficeBotShowLocationReport)
Retrieve bot location report.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot location report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_location_report+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_location_report
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/reports/monitoring
show_monitoring_report backoffice_bot (backofficeBotShowMonitoringReport)
Retrieve bot monitoring report.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot monitoring report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_monitoring_report+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_monitoring_report
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/reports/progress
show_progress_report backoffice_bot (backofficeBotShowProgressReport)
Retrieve bot progress over time report.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot progress report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_progress_report+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_progress_report
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/bots/{id}/responses/{responseID}
show_response backoffice_bot (backofficeBotShowResponse)
Retrieve bot response.
Path parameters
id (required)
Path Parameter — Bot ID
responseID (required)
Path Parameter — Response ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_response+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_response
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/response_actions/{responseActionID}/log_items/list
show_response_action_log_items backoffice_bot (backofficeBotShowResponseActionLogItems)
Retrieve bot response actions log items.
Path parameters
id (required)
Path Parameter — Bot ID
responseActionID (required)
Path Parameter — Response action ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot response actions log item collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_response_action_log_item_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_response_action_log_item_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/responses/list
show_responses backoffice_bot (backofficeBotShowResponses)
Retrieve bot responses.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot response collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_response_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_response_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/reports/stats
show_stats backoffice_bot (backofficeBotShowStats)
Retrieve bot stats.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot stats report payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_stats+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_stats
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/variables/{variableID}/log_items/list
show_variable_log_items backoffice_bot (backofficeBotShowVariableLogItems)
Retrieve bot variable log items.
Path parameters
id (required)
Path Parameter — Bot ID
variableID (required)
Path Parameter — Variable ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot variable log item collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_variable_log_item_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_variable_log_item_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bots/{id}/transfer
transfer backoffice_bot (backofficeBotTransfer)
Transfer the bot
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot transfer payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
Bot
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bots/{id}/channels/{channelID}/unlaunch
unlaunch_channel backoffice_bot (backofficeBotUnlaunchChannel)
Unlaunch bot channel.
Path parameters
channelID (required)
Path Parameter — Bot channel ID
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_channel+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_channel
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/bots/{id}
update backoffice_bot (backofficeBotUpdate)
Change bot
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot update payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
Bot
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/bots/batch_updates/{id}
update_batch_update backoffice_bot (backofficeBotUpdateBatchUpdate)
Update bot batch update.
Path parameters
id (required)
Path Parameter — Bot batch update ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot batch update payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_batch_update+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_batch_update
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/bots/{id}/channels/{channelID}
update_channel backoffice_bot (backofficeBotUpdateChannel)
Update bot channel.
Path parameters
channelID (required)
Path Parameter — Bot channel ID
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_channel+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_channel
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bot_channels/oauth_callback/{type}
authorize_channel backoffice_bot_channel (backofficeBotChannelAuthorizeChannel)
Authorize bot channel.
Path parameters
type (required)
Path Parameter — Channel type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
302
Redirect
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bot_templates/list
list backoffice_bot_template (backofficeBotTemplateList)
Retrieve all bot templates.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot template collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/bot_templates/{id}
show backoffice_bot_template (backofficeBotTemplateShow)
Retrieve bot template with given id.
Path parameters
id (required)
Path Parameter — Bot ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
Bot
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}/confirm
confirm_push_subscription backoffice_bouser (backofficeBouserConfirmPushSubscription)
Confirm backoffice user push subscription
Path parameters
id (required)
Path Parameter — Backoffice user ID
subscription_id (required)
Path Parameter — Backoffice user push subscription ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Backoffice user push subscription payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bousers/username_changes/confirm
confirm_username_change backoffice_bouser (backofficeBouserConfirmUsernameChange)
Confirm an username change.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice username change confirmation payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.authorized+jsonapplication/vnd.goa.error
Responses
200
OK
Authorized
400
Bad Request
error
Up
post /0.0.1/backoffice/bousers
create backoffice_bouser (backofficeBouserCreate)
Create new backoffice user
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
201
Object created
Bo_user
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bousers/{id}/api_keys
create_api_key backoffice_bouser (backofficeBouserCreateApiKey)
Create new backoffice user API key
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Backoffice user API key payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_api_key+jsonapplication/vnd.goa.error
Responses
201
Object created
Bo_user_api_key
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bousers/{id}/push_subscriptions/expo
create_expo_push_subscription backoffice_bouser (backofficeBouserCreateExpoPushSubscription)
Create new backoffice user expo push subscription
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Backoffice user expo push subscription payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_push_subscription+jsonapplication/vnd.goa.error
Responses
201
Object created
Bo_user_push_subscription
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bousers/{id}/push_subscriptions
create_push_subscription backoffice_bouser (backofficeBouserCreatePushSubscription)
Create new backoffice user push subscription
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_push_subscription+jsonapplication/vnd.goa.error
Responses
201
Object created
Bo_user_push_subscription
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/bousers/{id}
delete backoffice_bouser (backofficeBouserDelete)
Path parameters
id (required)
Path Parameter — Backoffice user ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/bousers/{id}/api_keys/{api_key_id}
delete_api_key backoffice_bouser (backofficeBouserDeleteApiKey)
Path parameters
api_key_id (required)
Path Parameter — Backoffice user API key ID
id (required)
Path Parameter — Backoffice user ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/bousers/{id}/oauth/{oauth_id}
delete_oauth backoffice_bouser (backofficeBouserDeleteOauth)
Path parameters
id (required)
Path Parameter — Backoffice user ID
oauth_id (required)
Path Parameter — Backoffice user oauth authorization ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}
delete_push_subscription backoffice_bouser (backofficeBouserDeletePushSubscription)
Path parameters
id (required)
Path Parameter — Backoffice user ID
subscription_id (required)
Path Parameter — Backoffice user push subscription ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bousers/list
list backoffice_bouser (backofficeBouserList)
Retrieve all backoffice users.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — User collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bousers/{id}/api_keys/list
list_api_key backoffice_bouser (backofficeBouserListApiKey)
Retrieve backoffice user API keys.
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user API key reference collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_userapi_key_reference_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_userapi_key_reference_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bousers/{id}/membership
list_membership backoffice_bouser (backofficeBouserListMembership)
List membership
Path parameters
id (required)
Path Parameter — Backoffice user ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice organisation membership collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation_membership_collection+json
Responses
200
OK
Organisation_membership_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bousers/{id}/push_subscriptions/list
list_push_subscription backoffice_bouser (backofficeBouserListPushSubscription)
Retrieve backoffice user push subscriotions.
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user push subscription collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_push_subscription_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user_push_subscription_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bousers/me
me backoffice_bouser (backofficeBouserMe)
Retrieve current backoffice user.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/bousers/{id}/username_changes
request_username_change backoffice_bouser (backofficeBouserRequestUsernameChange)
Request a user name change.
Path parameters
id (required)
Path Parameter — Backoffice user ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice username change request payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bousers/{id}
show backoffice_bouser (backofficeBouserShow)
Retrieve backoffice user with given id.
Path parameters
id (required)
Path Parameter — Backoffice user ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bousers/{id}/member_settings
show_member_settings backoffice_bouser (backofficeBouserShowMemberSettings)
Get backoffice user member settings
Path parameters
id (required)
Path Parameter — Backoffice user ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation_member_settings+json
Responses
200
OK
Organisation_member_settings
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/bousers/username_changes/{code}
show_username_change backoffice_bouser (backofficeBouserShowUsernameChange)
Retrieve backoffice user invite with given code.
Path parameters
code (required)
Path Parameter — Backoffice user username change code
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Query parameters
id (optional)
Query Parameter — Backoffice user ID
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_username_change+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user_username_change
400
Bad Request
error
404
Not Found
Up
patch /0.0.1/backoffice/bousers/{id}
update backoffice_bouser (backofficeBouserUpdate)
Change backoffice user
Path parameters
id (required)
Path Parameter — Backoffice user ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/bousers/{id}/member_settings
update_member_settings backoffice_bouser (backofficeBouserUpdateMemberSettings)
Update backoffice user member settings
Path parameters
id (required)
Path Parameter — Backoffice user ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Backoffice user member settings payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/bousers/{id}/push_subscriptions/{subscription_id}
update_push_subscription backoffice_bouser (backofficeBouserUpdatePushSubscription)
Update backoffice user push subscription
Path parameters
id (required)
Path Parameter — Backoffice user ID
subscription_id (required)
Path Parameter — Backoffice user push subscription ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Backoffice user push subscription payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/campaigns
create backoffice_campaign (backofficeCampaignCreate)
Create campaign
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Campaign payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.campaign+jsonapplication/vnd.goa.error
Responses
201
Created
Campaign
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/campaigns
delete backoffice_campaign (backofficeCampaignDelete)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Campaign delete payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/campaigns/list
list backoffice_campaign (backofficeCampaignList)
Retrieve all campaigns.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Campaign collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.campaign_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Campaign_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/campaigns/{id}/automation_rule_action_log_items/list
list_automation_rule_action_log_items backoffice_campaign (backofficeCampaignListAutomationRuleActionLogItems)
Retrieve campaign automation rule action log items.
Path parameters
id (required)
Path Parameter — Campaign ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Campaign automation rule action log item collection payload
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.campaign_automation_rule_action_log_item_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Campaign_automation_rule_action_log_item_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/campaigns/{id}/send
send backoffice_campaign (backofficeCampaignSend)
Send campaign
Path parameters
id (required)
Path Parameter — Campaign ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Campaign send payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.campaign+jsonapplication/vnd.goa.error
Responses
200
OK
Campaign
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/campaigns/{id}
show backoffice_campaign (backofficeCampaignShow)
Get campaign
Path parameters
id (required)
Path Parameter — Campaign ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.campaign+jsonapplication/vnd.goa.error
Responses
200
OK
Campaign
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/campaigns/{id}/unsend
unsend backoffice_campaign (backofficeCampaignUnsend)
Unsend campaign
Path parameters
id (required)
Path Parameter — Campaign ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.campaign+jsonapplication/vnd.goa.error
Responses
200
OK
Campaign
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/campaigns/{id}
update backoffice_campaign (backofficeCampaignUpdate)
Change campaign
Path parameters
id (required)
Path Parameter — Campaign ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Campaign payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.campaign+jsonapplication/vnd.goa.error
Responses
200
OK
Campaign
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/contacts
create backoffice_contact (backofficeContactCreate)
Create contact
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Chat contact payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.chat_contact+jsonapplication/vnd.goa.error
Responses
201
Object created
Chat_contact
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/contacts
delete backoffice_contact (backofficeContactDelete)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Chat contact delete payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/contacts/download
download backoffice_contact (backofficeContactDownload)
Download contacts.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Chat contact collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/contacts/list
list backoffice_contact (backofficeContactList)
Retrieve all contacts.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Chat contact collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.chat_contact_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Chat_contact_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/contacts/{id}
show backoffice_contact (backofficeContactShow)
Get contact
Path parameters
id (required)
Path Parameter — Contact ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.chat_contact+jsonapplication/vnd.goa.error
Responses
200
OK
Chat_contact
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/contacts/download/{downloadID}
show_download backoffice_contact (backofficeContactShowDownload)
Retrieve contacts download.
Path parameters
downloadID (required)
Path Parameter — Download ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/contacts/{id}
update backoffice_contact (backofficeContactUpdate)
Change contact
Path parameters
id (required)
Path Parameter — Contact ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Chat contact payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.chat_contact+jsonapplication/vnd.goa.error
Responses
200
OK
Chat_contact
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/downloads
delete backoffice_download (backofficeDownloadDelete)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Download delete payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/downloads/list
list backoffice_download (backofficeDownloadList)
Retrieve all downloads.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Download collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Download_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/downloads/{id}
show backoffice_download (backofficeDownloadShow)
Retrieve download.
Path parameters
id (required)
Path Parameter — Download ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/integrations/{type}/oauth_callback
authorize backoffice_integration (backofficeIntegrationAuthorize)
Authorize integration.
Path parameters
type (required)
Path Parameter — Integration type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
302
Redirect
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/integrations/{type}/{id}/configure
configure backoffice_integration (backofficeIntegrationConfigure)
Configure integration.
Path parameters
id (required)
Path Parameter — Integration ID
type (required)
Path Parameter — Integration type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.integration_config+json
Responses
200
OK
Integration_config
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/integrations/{type}/configure_view
configure_view backoffice_integration (backofficeIntegrationConfigureView)
Integration configure view.
Path parameters
type (required)
Path Parameter — Integration type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
HTMLapplication/vnd.goa.error
Responses
200
OK
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/integrations/{type}
create backoffice_integration (backofficeIntegrationCreate)
Create integration
Path parameters
type (required)
Path Parameter — Integration type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Integration payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.integration+json
Responses
201
Created
Integration
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/integrations/{type}/{id}
delete backoffice_integration (backofficeIntegrationDelete)
Path parameters
id (required)
Path Parameter — Integration ID
type (required)
Path Parameter — Integration type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/integrations/list
list backoffice_integration (backofficeIntegrationList)
Retrieve all integrations.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Integration collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.integration_collection+json
Responses
200
OK
Integration_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/integrations/types
list_type backoffice_integration (backofficeIntegrationListType)
Retrieve all integration types.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Integration type collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.integration_type_collection+json
Responses
200
OK
Integration_type_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/integrations/{type}/{id}
show backoffice_integration (backofficeIntegrationShow)
Get integration
Path parameters
id (required)
Path Parameter — Integration ID
type (required)
Path Parameter — Integration type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.integration+json
Responses
200
OK
Integration
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/integrations/open_ai/{id}/automation_rule_action_log_items/list
show_open_ai_automation_rule_action_log_items backoffice_integration (backofficeIntegrationShowOpenAiAutomationRuleActionLogItems)
Retrieve integration automation rule action log items.
Path parameters
id (required)
Path Parameter — Integration ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — OpenAI integration automation rule action log item collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.open_ai_integration_automation_rule_action_log_item_collection+json
Responses
200
OK
Open_ai_integration_automation_rule_action_log_item_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/integrations/{type}/{id}
update backoffice_integration (backofficeIntegrationUpdate)
Change integration
Path parameters
id (required)
Path Parameter — Integration ID
type (required)
Path Parameter — Integration type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Integration update payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.integration+json
Responses
200
OK
Integration
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/invites/accept
accept backoffice_invite (backofficeInviteAccept)
Confirm backoffice user invitation
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user invite accept payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user
400
Bad Request
error
Up
post /0.0.1/backoffice/invites
create backoffice_invite (backofficeInviteCreate)
Create new backoffice invite
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Invite create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_invite+jsonapplication/vnd.goa.error
Responses
201
Object created
Bo_user_invite
400
Bad Request
error
403
Forbidden
Up
delete /0.0.1/backoffice/invites
delete backoffice_invite (backofficeInviteDelete)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Backoffice user invite action payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/invites/list
list backoffice_invite (backofficeInviteList)
Retrieve all invites.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — User invite collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_invite_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user_invite_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/invites/resend
resend backoffice_invite (backofficeInviteResend)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Backoffice user invite action payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/invites/by_code/{id}
show backoffice_invite (backofficeInviteShow)
Retrieve backoffice user invite with given code.
Path parameters
id (required)
Path Parameter — Backoffice user invite code
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_invite+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user_invite
400
Bad Request
error
404
Not Found
Up
post /0.0.1/backoffice/knowledge_bases
create backoffice_knowledge_base (backofficeKnowledgeBaseCreate)
Create knowledge base
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base+json
Responses
201
Object created
Knowledge_base
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/knowledge_bases/{id}/articles
create_article backoffice_knowledge_base (backofficeKnowledgeBaseCreateArticle)
Create knowledge base article.
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base article payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_article+json
Responses
201
Object created
Knowledge_base_article
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/knowledge_bases/{id}/imports
create_import backoffice_knowledge_base (backofficeKnowledgeBaseCreateImport)
Create knowledge base import.
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base import payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_import+json
Responses
201
Object created
Knowledge_base_import
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/knowledge_bases/{id}
delete backoffice_knowledge_base (backofficeKnowledgeBaseDelete)
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/knowledge_bases/{id}/articles
delete_article backoffice_knowledge_base (backofficeKnowledgeBaseDeleteArticle)
Delete knowledge base article.
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base article delete payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/knowledge_bases/list
list backoffice_knowledge_base (backofficeKnowledgeBaseList)
Retrieve all knowledge bases.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_collection+json
Responses
200
OK
Knowledge_base_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/knowledge_bases/{id}/articles/list
list_article backoffice_knowledge_base (backofficeKnowledgeBaseListArticle)
Retrieve knowledge base article.
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base article collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_article_collection+json
Responses
200
OK
Knowledge_base_article_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/knowledge_bases/{id}/imports/list
list_import backoffice_knowledge_base (backofficeKnowledgeBaseListImport)
Retrieve knowledge base import list
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base import collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_import_collection+json
Responses
200
OK
Knowledge_base_import_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/knowledge_bases/{id}/redeploy
redeploy backoffice_knowledge_base (backofficeKnowledgeBaseRedeploy)
Re-deploy knowledge base
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/knowledge_bases/{id}/reindex
reindex backoffice_knowledge_base (backofficeKnowledgeBaseReindex)
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/knowledge_bases/{id}/articles/replace
replace_article backoffice_knowledge_base (backofficeKnowledgeBaseReplaceArticle)
Replace knowledge base article content.
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base article replace payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/knowledge_bases/{id}
show backoffice_knowledge_base (backofficeKnowledgeBaseShow)
Get knowledge base
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base+json
Responses
200
OK
Knowledge_base
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/knowledge_bases/{id}/articles/{articleID}
show_article backoffice_knowledge_base (backofficeKnowledgeBaseShowArticle)
Show knowledge base article.
Path parameters
articleID (required)
Path Parameter — Knowledge base article ID
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_article+json
Responses
200
OK
Knowledge_base_article
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/knowledge_bases/{id}/imports/{importID}
show_import backoffice_knowledge_base (backofficeKnowledgeBaseShowImport)
Show knowledge base import.
Path parameters
id (required)
Path Parameter — Knowledge base ID
importID (required)
Path Parameter — Knowledge base import ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_import+json
Responses
200
OK
Knowledge_base_import
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/knowledge_bases/{id}
update backoffice_knowledge_base (backofficeKnowledgeBaseUpdate)
Change knowledge base
Path parameters
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base+json
Responses
200
OK
Knowledge_base
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/knowledge_bases/{id}/articles/{articleID}
update_article backoffice_knowledge_base (backofficeKnowledgeBaseUpdateArticle)
Update knowledge base article.
Path parameters
articleID (required)
Path Parameter — Knowledge base article ID
id (required)
Path Parameter — Knowledge base ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base article payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_article+json
Responses
200
OK
Knowledge_base_article
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/assign
assign backoffice_live_chat (backofficeLiveChatAssign)
Assign chat(s)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat assign payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/{id}/channel_mode
channel_mode backoffice_live_chat (backofficeLiveChatChannelMode)
Change channel mode
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
200
OK
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/close
close backoffice_live_chat (backofficeLiveChatClose)
Close chat(s)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat update collection payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats
create backoffice_live_chat (backofficeLiveChatCreate)
Create chat
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
201
Object created
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/{id}/attachments
create_attachment backoffice_live_chat (backofficeLiveChatCreateAttachment)
Create chat attachment
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat attachment payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_attachment+json
Responses
201
Object created
Live_chat_attachment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/imports
create_import backoffice_live_chat (backofficeLiveChatCreateImport)
Create live chat import.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat import payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_import+json
Responses
201
Object created
Live_chat_import
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/{id}/messages
create_message backoffice_live_chat (backofficeLiveChatCreateMessage)
Create chat message
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat message payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_message+json
Responses
201
Object created
Live_chat_message
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/views
create_view backoffice_live_chat (backofficeLiveChatCreateView)
Create a live chat search view.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat search view payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_search_view+json
Responses
201
Object created
Live_chat_search_view
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/live_chats
delete backoffice_live_chat (backofficeLiveChatDelete)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat update collection payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/live_chats/{id}/attachments/{attachment_id}
delete_attachment backoffice_live_chat (backofficeLiveChatDeleteAttachment)
Delete chat attachment
Path parameters
attachment_id (required)
Path Parameter — Chat attachment ID
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/live_chats/views/{viewID}
delete_view backoffice_live_chat (backofficeLiveChatDeleteView)
Delete live chat search view.
Path parameters
viewID (required)
Path Parameter — View ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/handover_to_bot
handover_to_bot backoffice_live_chat (backofficeLiveChatHandoverToBot)
Handover chat(s) to bot
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat update collection payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/{id}/join
join backoffice_live_chat (backofficeLiveChatJoin)
Join chat
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent+jsonapplication/vnd.goa.error
Responses
200
OK
Agent
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/{id}/leave
leave backoffice_live_chat (backofficeLiveChatLeave)
Leave chat
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.agent+jsonapplication/vnd.goa.error
Responses
200
OK
Agent
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/list
list backoffice_live_chat (backofficeLiveChatList)
Retrieve all chats.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_collection+json
Responses
200
OK
Live_chat_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/live_chats/imports/list
list_import backoffice_live_chat (backofficeLiveChatListImport)
Retrieve live chat import list
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat import collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_import_collection+json
Responses
200
OK
Live_chat_import_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/live_chats/{id}/messages/list
list_messages backoffice_live_chat (backofficeLiveChatListMessages)
List chat messages
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat message collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_message_collection+json
Responses
200
OK
Live_chat_message_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/views/list
list_views backoffice_live_chat (backofficeLiveChatListViews)
Retrieve live chat search view list
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat search view collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_search_view_collection+json
Responses
200
OK
Live_chat_search_view_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/live_chats/mark_spam
mark_spam backoffice_live_chat (backofficeLiveChatMarkSpam)
Mark chat(s) as spam
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat update collection payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/merge
merge backoffice_live_chat (backofficeLiveChatMerge)
Merge chats
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat merge payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/reopen
reopen backoffice_live_chat (backofficeLiveChatReopen)
Reopen chat(s)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat update collection payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/live_chats/{id}
show backoffice_live_chat (backofficeLiveChatShow)
Show chat
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
200
OK
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/live_chats/{id}/attachments/{attachment_id}
show_attachment backoffice_live_chat (backofficeLiveChatShowAttachment)
Show chat attachment
Path parameters
attachment_id (required)
Path Parameter — Chat attachment ID
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_attachment+json
Responses
200
OK
Live_chat_attachment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/live_chats/imports/{importID}
show_import backoffice_live_chat (backofficeLiveChatShowImport)
Show live chat import.
Path parameters
importID (required)
Path Parameter — Import ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_import+json
Responses
200
OK
Live_chat_import
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/live_chats/{id}/messages/{message_id}
show_message backoffice_live_chat (backofficeLiveChatShowMessage)
Show chat message
Path parameters
id (required)
Path Parameter — Chat ID
message_id (required)
Path Parameter — Chat message ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_message+json
Responses
200
OK
Live_chat_message
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/live_chats/views/{viewID}
show_view backoffice_live_chat (backofficeLiveChatShowView)
Show live chat search view.
Path parameters
viewID (required)
Path Parameter — View ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_search_view+json
Responses
200
OK
Live_chat_search_view
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/{id}/translation_mode
translation_mode backoffice_live_chat (backofficeLiveChatTranslationMode)
Change translation mode
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
200
OK
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chats/unmark_spam
unmark_spam backoffice_live_chat (backofficeLiveChatUnmarkSpam)
Mark chat(s) as spam
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat update collection payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/live_chats/{id}
update backoffice_live_chat (backofficeLiveChatUpdate)
Change chat
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
200
OK
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/live_chats/views/{viewID}
update_view backoffice_live_chat (backofficeLiveChatUpdateView)
Update live chat search view.
Path parameters
viewID (required)
Path Parameter — View ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat search view payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_search_view+json
Responses
200
OK
Live_chat_search_view
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chat_canned_responses
create backoffice_live_chat_canned_response (backofficeLiveChatCannedResponseCreate)
Create canned response
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat canned response payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_canned_response+json
Responses
201
Object created
Live_chat_canned_response
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/live_chat_canned_responses
delete backoffice_live_chat_canned_response (backofficeLiveChatCannedResponseDelete)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat canned response collection payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/live_chat_canned_responses/list
list backoffice_live_chat_canned_response (backofficeLiveChatCannedResponseList)
Retrieve all canned responses.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat canned response collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_canned_response_collection+json
Responses
200
OK
Live_chat_canned_response_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/live_chat_canned_responses/{id}/render
render backoffice_live_chat_canned_response (backofficeLiveChatCannedResponseRender)
Render canned response
Path parameters
id (required)
Path Parameter — Canned response ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat canned response render payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_message+json
Responses
201
Object created
Live_chat_message
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/live_chat_canned_responses/{id}
show backoffice_live_chat_canned_response (backofficeLiveChatCannedResponseShow)
Get canned response
Path parameters
id (required)
Path Parameter — Canned response ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_canned_response+json
Responses
200
OK
Live_chat_canned_response
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/live_chat_canned_responses/{id}
update backoffice_live_chat_canned_response (backofficeLiveChatCannedResponseUpdate)
Change canned response
Path parameters
id (required)
Path Parameter — Canned response ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat canned response payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_canned_response+json
Responses
200
OK
Live_chat_canned_response
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/lock
create backoffice_lock (backofficeLockCreate)
Obtain object lock
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Object lock payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.lock+json
Responses
200
OK
Lock
201
Object created
Lock
400
Bad Request
error
Up
delete /0.0.1/backoffice/lock
delete backoffice_lock (backofficeLockDelete)
Delete object lock
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Object delete lock payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
Up
post /0.0.1/backoffice/bouser_oauth_registrations/confirm
confirm backoffice_oauth_registration (backofficeOauthRegistrationConfirm)
Confirm backoffice oauth user registration
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice oauth user registration confirm payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user
400
Bad Request
error
Up
get /0.0.1/backoffice/bouser_oauth_registrations/by_token/{id}
show backoffice_oauth_registration (backofficeOauthRegistrationShow)
Retrieve backoffice oauth user registration with given token.
Path parameters
id (required)
Path Parameter — Backoffice user oauth registration token
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_oauth_registration+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user_oauth_registration
400
Bad Request
error
404
Not Found
Up
post /0.0.1/backoffice/organisations/activate
activate backoffice_organisation (backofficeOrganisationActivate)
Activate the organisation. Meant to be used by the main organization with the agency subscription
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Organisation activate payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation_activation_result+json
Responses
200
OK
Organisation_activation_result
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations
create backoffice_organisation (backofficeOrganisationCreate)
Create new organisation
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Organisation create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation+json
Responses
201
Object created
Organisation
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/organisations/{id}/domain_settings/domains
create_domain backoffice_organisation (backofficeOrganisationCreateDomain)
Create new domain
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Domain create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.domain+jsonapplication/vnd.goa.error
Responses
201
Object created
Domain
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations/{id}/email_settings/from_addresses
create_from_address backoffice_organisation (backofficeOrganisationCreateFromAddress)
Create new from address
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Email address create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.email_from_address+jsonapplication/vnd.goa.error
Responses
201
Object created
Email_from_address
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations/{id}/billing_settings/mandate_payments
create_mandate_payment backoffice_organisation (backofficeOrganisationCreateMandatePayment)
Create new mandate payment
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Payment create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.payment+json
Responses
201
Object created
Payment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses
create_replyto_address backoffice_organisation (backofficeOrganisationCreateReplytoAddress)
Create new reply to address
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Email address create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.email_replyto_address+jsonapplication/vnd.goa.error
Responses
201
Object created
Email_replyto_address
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations/deactivate
deactivate backoffice_organisation (backofficeOrganisationDeactivate)
Deactivate the organisation. Meant to be used by the main organization with the agency subscription
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Organisation deactivate payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/organisations/{id}
delete backoffice_organisation (backofficeOrganisationDelete)
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/organisations/{id}/domain_settings/domains/{domain_id}
delete_domain backoffice_organisation (backofficeOrganisationDeleteDomain)
Delete domain
Path parameters
domain_id (required)
Path Parameter — Domain ID
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/organisations/{id}/email_settings/from_addresses/{address_id}
delete_from_address backoffice_organisation (backofficeOrganisationDeleteFromAddress)
Delete from address
Path parameters
address_id (required)
Path Parameter — Address ID
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/organisations/{id}/membership/{membership_id}
delete_membership backoffice_organisation (backofficeOrganisationDeleteMembership)
Delete membership
Path parameters
id (required)
Path Parameter — Organisation ID
membership_id (required)
Path Parameter — Membership ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/{mandate_id}
delete_payment_mandate backoffice_organisation (backofficeOrganisationDeletePaymentMandate)
Delete payment mandate
Path parameters
id (required)
Path Parameter — Organisation ID
mandate_id (required)
Path Parameter — Mandate ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses/{address_id}
delete_replyto_address backoffice_organisation (backofficeOrganisationDeleteReplytoAddress)
Delete replyto address
Path parameters
address_id (required)
Path Parameter — Address ID
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/{mandate_id}
get_payment_mandate backoffice_organisation (backofficeOrganisationGetPaymentMandate)
Get payment mandate
Path parameters
id (required)
Path Parameter — Organisation ID
mandate_id (required)
Path Parameter — Mandate ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.payment_mandate+json
Responses
200
OK
Payment_mandate
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations/list
list backoffice_organisation (backofficeOrganisationList)
Retrieve all organisations.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice organisation collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation_collection+json
Responses
200
OK
Organisation_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/organisations/{id}/domain_settings/domains/list
list_domains backoffice_organisation (backofficeOrganisationListDomains)
List domains
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice domain collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.domain_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Domain_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/organisations/{id}/email_settings/from_addresses
list_from_addresses backoffice_organisation (backofficeOrganisationListFromAddresses)
List from addresses
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.email_from_address_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Email_from_address_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations/{id}/membership
list_membership backoffice_organisation (backofficeOrganisationListMembership)
List membership
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice organisation membership collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation_membership_collection+json
Responses
200
OK
Organisation_membership_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations/{id}/billing_settings/payment_mandates/list
list_payment_mandates backoffice_organisation (backofficeOrganisationListPaymentMandates)
List new payment mandates
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.payment_mandate_collection+json
Responses
200
OK
Payment_mandate_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/organisations/{id}/email_settings/replyto_addresses
list_replyto_addresses backoffice_organisation (backofficeOrganisationListReplytoAddresses)
List reply to addresses
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.email_replyto_address_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Email_replyto_address_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/organisations/{id}
show backoffice_organisation (backofficeOrganisationShow)
Retrieve organisation with given id.
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation+json
Responses
200
OK
Organisation
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisations/{id}/live_chat/automation_rule_action_log_items/list
show_live_chat_automation_rule_action_log_items backoffice_organisation (backofficeOrganisationShowLiveChatAutomationRuleActionLogItems)
Retrieve live chat automation rule action log items.
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat automation rule action log item collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_automation_rule_action_log_item_collection+json
Responses
200
OK
Live_chat_automation_rule_action_log_item_collection
400
Bad Request
error
403
Forbidden
Up
patch /0.0.1/backoffice/organisations/{id}
update backoffice_organisation (backofficeOrganisationUpdate)
Change organisation
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Organisation update payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation+json
Responses
200
OK
Organisation
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/organisations/{id}/email_settings/from_addresses/{address_id}
update_from_address backoffice_organisation (backofficeOrganisationUpdateFromAddress)
Update from address
Path parameters
address_id (required)
Path Parameter — Address ID
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Email address update payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.email_from_address+jsonapplication/vnd.goa.error
Responses
200
OK
Email_from_address
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/organisations/{id}/membership/{membership_id}
update_membership backoffice_organisation (backofficeOrganisationUpdateMembership)
Update membership
Path parameters
id (required)
Path Parameter — Organisation ID
membership_id (required)
Path Parameter — Membership ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Organisation membership update payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisation_referrals/{id}/payments
create_payment backoffice_organisation_referral (backofficeOrganisationReferralCreatePayment)
Create an organisation referral payment for given organisation.
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — An organisation referral payment payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation_referral_payment+json
Responses
201
Object created
Organisation_referral_payment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/organisation_referrals/{id}/payments/list
list_payments backoffice_organisation_referral (backofficeOrganisationReferralListPayments)
Retrieve organisation referral payments for given organisation.
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice organisation referral payment collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation_referral_payment_collection+json
Responses
200
OK
Organisation_referral_payment_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/backoffice/organisation_referrals/{id}
show backoffice_organisation_referral (backofficeOrganisationReferralShow)
Retrieve organisation referral for given organisation.
Path parameters
id (required)
Path Parameter — Organisation ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.organisation_referral+json
Responses
200
OK
Organisation_referral
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/passwords
score backoffice_password (backofficePasswordScore)
Get password score
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Password score payload
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.password_score+json
Responses
200
OK
Password_score
Up
get /0.0.1/backoffice/payments/{id}/finish
finish backoffice_payment (backofficePaymentFinish)
Finish the payment process.
Path parameters
id (required)
Path Parameter — Payment ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/payments/list
list backoffice_payment (backofficePaymentList)
Retrieve all payments.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Payment collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.payment_collection+json
Responses
200
OK
Payment_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/payments/{id}
show backoffice_payment (backofficePaymentShow)
Retrieve payment with given id.
Path parameters
id (required)
Path Parameter — Payment ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.payment+json
Responses
200
OK
Payment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/payments/status
update_status backoffice_payment (backofficePaymentUpdateStatus)
Retrieve payment status from the provider.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Payment update status payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.payment+json
Responses
200
OK
Payment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/payments/update_status
update_statuses backoffice_payment (backofficePaymentUpdateStatuses)
Schedule an update of payment statuses.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/bouser_registrations/confirm
confirm backoffice_registration (backofficeRegistrationConfirm)
Confirm backoffice user registration
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user registration confirmation payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user
400
Bad Request
error
Up
post /0.0.1/backoffice/bouser_registrations
create backoffice_registration (backofficeRegistrationCreate)
Create new backoffice user registration
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice user registration payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
201
Resource created
400
Bad Request
error
Up
delete /0.0.1/backoffice/bouser_registrations/{id}
delete backoffice_registration (backofficeRegistrationDelete)
Path parameters
id (required)
Path Parameter — Backoffice user registration ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/backoffice/bouser_registrations/list
list backoffice_registration (backofficeRegistrationList)
Retrieve all backoffice registrations.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_registration+json; type=collection
Responses
200
OK
Bo_user_registrationCollection
Up
get /0.0.1/backoffice/bouser_registrations/{id}
show backoffice_registration (backofficeRegistrationShow)
Retrieve backoffice user registration with given id.
Path parameters
id (required)
Path Parameter — Backoffice user registration ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bo_user_registration+jsonapplication/vnd.goa.error
Responses
200
OK
Bo_user_registration
400
Bad Request
error
404
Not Found
Up
delete /0.0.1/backoffice/subscribers
delete backoffice_subscriber (backofficeSubscriberDelete)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscriber delete payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscribers/download
download backoffice_subscriber (backofficeSubscriberDownload)
Download subscribers.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscriber collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/subscribers/list
list backoffice_subscriber (backofficeSubscriberList)
Retrieve all subscribers.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscriber collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscriber_collection+json
Responses
200
OK
Subscriber_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/subscribers/{id}
show backoffice_subscriber (backofficeSubscriberShow)
Get subscriber
Path parameters
id (required)
Path Parameter — Subscriber ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscriber+json
Responses
200
OK
Subscriber
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscriber_groups
create backoffice_subscriber_group (backofficeSubscriberGroupCreate)
Create subscriber group
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — SubscriberGroup payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscriber_group+json
Responses
201
Created
Subscriber_group
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/backoffice/subscriber_groups
delete backoffice_subscriber_group (backofficeSubscriberGroupDelete)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscriber group delete payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscriber_groups/list
list backoffice_subscriber_group (backofficeSubscriberGroupList)
Retrieve all subscriber groups.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — SubscriberGroup collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscriber_group_collection+json
Responses
200
OK
Subscriber_group_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/subscriber_groups/{id}
show backoffice_subscriber_group (backofficeSubscriberGroupShow)
Get subscriber group
Path parameters
id (required)
Path Parameter — Subscriber group ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscriber_group+json
Responses
200
OK
Subscriber_group
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/subscriber_groups/{id}
update backoffice_subscriber_group (backofficeSubscriberGroupUpdate)
Change subscriber group
Path parameters
id (required)
Path Parameter — Subscriber group ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — SubscriberGroup payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscriber_group+json
Responses
200
OK
Subscriber_group
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscription_bill
show backoffice_subscription_bill (backofficeSubscriptionBillShow)
Retrieve a subscription bill.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription bill payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_bill+json
Responses
200
OK
Subscription_bill
400
Bad Request
error
Up
post /0.0.1/backoffice/subscription_invoices/{id}/payments
create_payment backoffice_subscription_invoice (backofficeSubscriptionInvoiceCreatePayment)
Create new payment
Path parameters
id (required)
Path Parameter — Subscription invoice ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Payment create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.payment+json
Responses
201
Object created
Payment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscription_invoices/create_payments
create_payments backoffice_subscription_invoice (backofficeSubscriptionInvoiceCreatePayments)
Create payments for existing invoices.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
Up
delete /0.0.1/backoffice/subscription_invoices/{id}
delete backoffice_subscription_invoice (backofficeSubscriptionInvoiceDelete)
Path parameters
id (required)
Path Parameter — Invoice ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
get /0.0.1/backoffice/subscription_invoices/{id}/download/{format}
download backoffice_subscription_invoice (backofficeSubscriptionInvoiceDownload)
Retrieve subscription invoice with given id.
Path parameters
format (required)
Path Parameter — Format
id (required)
Path Parameter — Subscription invoice ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscription_invoices/list/download
download_list backoffice_subscription_invoice (backofficeSubscriptionInvoiceDownloadList)
Download all invoices in PDF format.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice subscription invoice update collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/subscription_invoices/generate
generate backoffice_subscription_invoice (backofficeSubscriptionInvoiceGenerate)
Generate outstanding invoices.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/subscription_invoices/list
list backoffice_subscription_invoice (backofficeSubscriptionInvoiceList)
Retrieve all invoices.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice subscription invoice collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_invoice_collection+json
Responses
200
OK
Subscription_invoice_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/subscription_invoices/rerender
rerender backoffice_subscription_invoice (backofficeSubscriptionInvoiceRerender)
Rerender existing invoice(s).
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription invoice rerender payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/subscription_invoices/retry_payments
retry_payments backoffice_subscription_invoice (backofficeSubscriptionInvoiceRetryPayments)
Retry payments for invoices with failed payments.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription invoice retry failed payments payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/subscription_invoices/{id}
show backoffice_subscription_invoice (backofficeSubscriptionInvoiceShow)
Retrieve subscription invoice with given id.
Path parameters
id (required)
Path Parameter — Subscription invoice ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_invoice+json
Responses
200
OK
Subscription_invoice
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/subscription_invoices/{id}
update backoffice_subscription_invoice (backofficeSubscriptionInvoiceUpdate)
Change subscription invoice
Path parameters
id (required)
Path Parameter — Invoice ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription invoice update payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_invoice+json
Responses
200
OK
Subscription_invoice
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscription_invoice_bill
show backoffice_subscription_invoice_bill (backofficeSubscriptionInvoiceBillShow)
Retrieve a subscription invoice bill.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription invoice bill payload
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_invoice_bill+json
Responses
200
OK
Subscription_invoice_bill
400
Bad Request
error
Up
post /0.0.1/backoffice/subscription_orders/{id}/checkout
checkout backoffice_subscription_order (backofficeSubscriptionOrderCheckout)
Checkout the subscription order
Path parameters
id (required)
Path Parameter — Subscription order ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription order checkout payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_order+json
Responses
200
OK
Subscription_order
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscription_orders
create backoffice_subscription_order (backofficeSubscriptionOrderCreate)
Create a new subscription order.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription order payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_order+json
Responses
201
Object created
Subscription_order
400
Bad Request
error
Up
post /0.0.1/backoffice/subscription_orders/list
list backoffice_subscription_order (backofficeSubscriptionOrderList)
Retrieve all organisations.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice subscription order collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_order_collection+json
Responses
200
OK
Subscription_order_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/subscription_orders/{id}
show backoffice_subscription_order (backofficeSubscriptionOrderShow)
Retrieve subscription order with given id.
Path parameters
id (required)
Path Parameter — Subscription order ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_order+json
Responses
200
OK
Subscription_order
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/subscription_orders/{id}
update backoffice_subscription_order (backofficeSubscriptionOrderUpdate)
Change subscription order
Path parameters
id (required)
Path Parameter — Order ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription order update payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_order+json
Responses
200
OK
Subscription_order
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/subscription_plans/list
list backoffice_subscription_plan (backofficeSubscriptionPlanList)
Retrieve all subscription plans.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_plan_collection+json
Responses
200
OK
Subscription_plan_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/subscription_plans/{id}
show backoffice_subscription_plan (backofficeSubscriptionPlanShow)
Retrieve a subscription plan.
Path parameters
id (required)
Path Parameter — Subscription plan ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_plan+json
Responses
200
OK
Subscription_plan
400
Bad Request
error
Up
post /0.0.1/backoffice/subscription_vouchers/list/download
download backoffice_subscription_voucher (backofficeSubscriptionVoucherDownload)
Download all vouchers.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice subscription voucher collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.download+jsonapplication/vnd.goa.error
Responses
200
OK
Download
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/subscription_vouchers/list
list backoffice_subscription_voucher (backofficeSubscriptionVoucherList)
Retrieve all vouchers.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice subscription voucher collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_voucher_collection+json
Responses
200
OK
Subscription_voucher_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/subscription_voucher_groups
create backoffice_subscription_voucher_group (backofficeSubscriptionVoucherGroupCreate)
Create a new subscription voucher group.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription order payload
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_voucher_group+json
Responses
201
Object created
Subscription_voucher_group
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/backoffice/subscription_voucher_groups/list
list backoffice_subscription_voucher_group (backofficeSubscriptionVoucherGroupList)
Retrieve all voucher groups.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — A backoffice subscription voucher group collection payload
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_voucher_group_collection+json
Responses
200
OK
Subscription_voucher_group_collection
400
Bad Request
error
403
Forbidden
Up
get /0.0.1/backoffice/subscription_voucher_groups/{id}
show backoffice_subscription_voucher_group (backofficeSubscriptionVoucherGroupShow)
Retrieve subscription voucher group with given id.
Path parameters
id (required)
Path Parameter — Voucher group ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_voucher_group+json
Responses
200
OK
Subscription_voucher_group
400
Bad Request
error
403
Forbidden
404
Not Found
Up
patch /0.0.1/backoffice/subscription_voucher_groups/{id}
update backoffice_subscription_voucher_group (backofficeSubscriptionVoucherGroupUpdate)
Change subscription voucher group
Path parameters
id (required)
Path Parameter — Voucher group ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Subscription order payload
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.subscription_voucher_group+json
Responses
200
OK
Subscription_voucher_group
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/backoffice/version
create backoffice_version (backofficeVersionCreate)
Create object version
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Object version payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.object_version+json
Responses
201
Object created
Object_version
400
Bad Request
error
Up
post /0.0.1/backoffice/version/list
list backoffice_version (backofficeVersionList)
Retrieve object versions.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Object version collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.object_version_collection+json
Responses
200
OK
Object_version_collection
400
Bad Request
error
403
Forbidden
configuration configuration (configurationConfiguration)
API configuration.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.api_configuration+json
Responses
200
OK
Api_configuration
Up
get /0.0.1/frontend/bots/by_domain/{id}/{slug}
show frontend_bot (frontendBotShow)
Retrieve questionnaire with given organisation id/slug and bot id/slug.
Path parameters
id (required)
Path Parameter — Bot id or slug
slug (required)
Path Parameter — Bot slug
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Query parameters
organisation (optional)
Query Parameter — Organisation id or slug
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
Bot
400
Bad Request
error
404
Not Found
530
Quota exceeded (free plan)
531
Quota exceeded (paid plan)
532
Trigger condition not passed
Up
get /0.0.1/frontend/bots/by_domain/{id}
show frontend_bot (frontendBotShow1)
Retrieve questionnaire with given organisation id/slug and bot id/slug.
Path parameters
id (required)
Path Parameter — Bot id or slug
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Query parameters
organisation (optional)
Query Parameter — Organisation id or slug
slug (optional)
Query Parameter — Bot slug
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
Bot
400
Bad Request
error
404
Not Found
530
Quota exceeded (free plan)
531
Quota exceeded (paid plan)
532
Trigger condition not passed
Up
get /0.0.1/frontend/bots/{organisation}/{id}
show frontend_bot (frontendBotShow2)
Retrieve questionnaire with given organisation id/slug and bot id/slug.
Path parameters
id (required)
Path Parameter — Bot id or slug
organisation (required)
Path Parameter — Organisation id or slug
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Query parameters
slug (optional)
Query Parameter — Bot slug
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot+jsonapplication/vnd.goa.error
Responses
200
OK
Bot
400
Bad Request
error
404
Not Found
530
Quota exceeded (free plan)
531
Quota exceeded (paid plan)
532
Trigger condition not passed
Up
post /0.0.1/frontend/bots/{organisation}/{id}/start
start frontend_bot (frontendBotStart)
Start the bot with given organisation id/slug and bot id/slug.
Path parameters
id (required)
Path Parameter — Bot id or slug
organisation (required)
Path Parameter — Organisation id or slug
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot start payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_response+jsonapplication/vnd.goa.error
Responses
201
Object created
Bot_responseReference
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/answer
answer_step frontend_chat (frontendChatAnswerStep)
Answer Facebook chat step
Path parameters
channel (required)
Path Parameter — Channel
chatID (required)
Path Parameter — Chat id
id (required)
Path Parameter — Bot step id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot chat step answer payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/{textID}/feedback
create_step_text_feedback frontend_chat (frontendChatCreateStepTextFeedback)
Create step text feedback
Path parameters
channel (required)
Path Parameter — Channel
chatID (required)
Path Parameter — Chat id
id (required)
Path Parameter — Bot step id
textID (required)
Path Parameter — Bot step chat text id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot chat step text feedback payload
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/dialog360/events/{channelID}/{token}
dialog360_event frontend_chat (frontendChatDialog360Event)
Receive Dialog360 event webhook.
Path parameters
channelID (required)
Path Parameter — Channel id
token (required)
Path Parameter — Token
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/fb/message
fb_message frontend_chat (frontendChatFbMessage)
Receive fb message events webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
get /0.0.1/frontend/chats/fb/message
fb_message_verify frontend_chat (frontendChatFbMessageVerify)
Verify fb message events webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errortext/plain
Responses
200
String
400
Bad Request
error
Up
post /0.0.1/frontend/chats/gbm/event
gbm_event frontend_chat (frontendChatGbmEvent)
Receive Google Business Messages event webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errortext/plain
Responses
200
OK
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/instagram/message
instagram_message frontend_chat (frontendChatInstagramMessage)
Receive instagram message events webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
get /0.0.1/frontend/chats/instagram/message
instagram_message_verify frontend_chat (frontendChatInstagramMessageVerify)
Verify instagram message events webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errortext/plain
Responses
200
String
400
Bad Request
error
Up
post /0.0.1/frontend/chats/line/events/{channelID}
line_events frontend_chat (frontendChatLineEvents)
Receive line events webhook.
Path parameters
channelID (required)
Path Parameter — Channel id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errortext/plain
Responses
200
OK
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/message_bird/events/{channelID}
message_bird_events frontend_chat (frontendChatMessageBirdEvents)
Receive MessageBird events webhook.
Path parameters
channelID (required)
Path Parameter — Channel id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/message_bird/events/{channelID}/status/{messageID}
message_bird_status frontend_chat (frontendChatMessageBirdStatus)
Receive message bird message status events webhook.
Path parameters
channelID (required)
Path Parameter — Channel id
messageID (required)
Path Parameter — Message id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
get /0.0.1/frontend/chats/{channel}/step/{chatID}/{id}
show_step frontend_chat (frontendChatShowStep)
Get chat step
Path parameters
channel (required)
Path Parameter — Channel
chatID (required)
Path Parameter — Chat id
id (required)
Path Parameter — Bot step id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_chat_step+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_chat_step
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/options
show_step_options frontend_chat (frontendChatShowStepOptions)
Get chat step options
Path parameters
channel (required)
Path Parameter — Channel
chatID (required)
Path Parameter — Chat id
id (required)
Path Parameter — Bot step id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Bot chat step option collection payload
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_chat_step_option_collection+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_chat_step_option_collection
400
Bad Request
error
404
Not Found
Up
get /0.0.1/frontend/chats/{channel}/step/{chatID}/{id}/{textID}
show_step_text frontend_chat (frontendChatShowStepText)
Get step chat text
Path parameters
channel (required)
Path Parameter — Channel
chatID (required)
Path Parameter — Chat id
id (required)
Path Parameter — Bot step id
textID (required)
Path Parameter — Bot step chat text id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.frontend_bot_chat_text+jsonapplication/vnd.goa.error
Responses
200
OK
Frontend_bot_chat_text
400
Bad Request
error
404
Not Found
Up
get /0.0.1/frontend/chats/{channel}/step/{chatID}/variables/{variable}
show_variable frontend_chat (frontendChatShowVariable)
Get chat variable
Path parameters
channel (required)
Path Parameter — Channel
chatID (required)
Path Parameter — Chat id
variable (required)
Path Parameter — Bot variable name
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Response create payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_chat_variable+jsonapplication/vnd.goa.error
Responses
200
OK
Bot_chat_variable
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/telegram/events/{channelID}/{token}
telegram_event frontend_chat (frontendChatTelegramEvent)
Receive Telegram event webhook.
Path parameters
channelID (required)
Path Parameter — Channel id
token (required)
Path Parameter — Token
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/twilio_whatsapp/message
twilio_whatsapp_message frontend_chat (frontendChatTwilioWhatsappMessage)
Receive whatsapp message events webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/twilio_whatsapp/status/{messageID}
twilio_whatsapp_status frontend_chat (frontendChatTwilioWhatsappStatus)
Receive whatsapp message status events webhook.
Path parameters
messageID (required)
Path Parameter — Message id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/chats/twitter/event
twitter_events frontend_chat (frontendChatTwitterEvents)
Receive twitter events webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
get /0.0.1/frontend/chats/twitter/event
twitter_events_verify frontend_chat (frontendChatTwitterEventsVerify)
Verify twitter events webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.twitter_events_verify_response+json
Responses
200
OK
Twitter_events_verify_response
400
Bad Request
error
Up
post /0.0.1/frontend/chats/viber/events/{channelID}
viber_event frontend_chat (frontendChatViberEvent)
Receive Viber event webhook.
Path parameters
channelID (required)
Path Parameter — Channel id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
Up
post /0.0.1/frontend/knowledge_bases/search
search frontend_knowledge_base (frontendKnowledgeBaseSearch)
Search among the knowledge base(s)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Knowledge base search payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.knowledge_base_search_result_item_collection+json
Responses
200
OK
Knowledge_base_search_result_item_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/frontend/live_chats/{id}/close
close frontend_live_chat (frontendLiveChatClose)
Close chat
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
200
OK
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/frontend/live_chats
create frontend_live_chat (frontendLiveChatCreate)
Create chat
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
201
Object created
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/frontend/live_chats/{id}/attachments
create_attachment frontend_live_chat (frontendLiveChatCreateAttachment)
Create chat attachment
Path parameters
id (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat attachment payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_attachment+json
Responses
201
Object created
Live_chat_attachment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/frontend/live_chats/{id}/messages
create_message frontend_live_chat (frontendLiveChatCreateMessage)
Create chat message
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat message payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_message+json
Responses
201
Object created
Live_chat_message
400
Bad Request
error
403
Forbidden
404
Not Found
Up
delete /0.0.1/frontend/live_chats/{id}/attachments/{attachment_id}
delete_attachment frontend_live_chat (frontendLiveChatDeleteAttachment)
Delete chat attachment
Path parameters
attachment_id (required)
Path Parameter — Chat attachment ID
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/frontend/live_chats/list
list frontend_live_chat (frontendLiveChatList)
Retrieve all chats.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_collection+json
Responses
200
OK
Live_chat_collection
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/frontend/live_chats/{id}/messages/list
list_messages frontend_live_chat (frontendLiveChatListMessages)
List chat messages
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat message collection payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_message_collection+json
Responses
200
OK
Live_chat_message_collection
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/frontend/live_chats/preview
preview frontend_live_chat (frontendLiveChatPreview)
Get chat preview
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Live chat payload
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
200
OK
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/frontend/live_chats/{id}/reopen
reopen frontend_live_chat (frontendLiveChatReopen)
Reopen chat
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
200
OK
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/frontend/live_chats/{id}
show frontend_live_chat (frontendLiveChatShow)
Show chat
Path parameters
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat+json
Responses
200
OK
Live_chat
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/frontend/live_chats/{id}/attachments/{attachment_id}
show_attachment frontend_live_chat (frontendLiveChatShowAttachment)
Show chat attachment
Path parameters
attachment_id (required)
Path Parameter — Chat attachment ID
id (required)
Path Parameter — Chat ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_attachment+json
Responses
200
OK
Live_chat_attachment
400
Bad Request
error
403
Forbidden
404
Not Found
Up
get /0.0.1/frontend/live_chats/{id}/messages/{message_id}
show_message frontend_live_chat (frontendLiveChatShowMessage)
Show chat message
Path parameters
id (required)
Path Parameter — Chat ID
message_id (required)
Path Parameter — Chat message ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request headers
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.live_chat_message+json
Responses
200
OK
Live_chat_message
400
Bad Request
error
403
Forbidden
404
Not Found
Up
post /0.0.1/frontend/mail/message
message frontend_mail (frontendMailMessage)
Receive message events webhook.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Mail payload
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
404
Not Found
health health (healthHealth)
Perform health check.
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
503
Service Unavailable
Up
post /0.0.1/quriobot/responses
create quriobot_responses (quriobotResponsesCreate)
Create response
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Response create payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/quriobot/responses/{id}/upload/{stepID}
create_upload quriobot_responses (quriobotResponsesCreateUpload)
Create file upload
Path parameters
id (required)
Path Parameter — Response id
stepID (required)
Path Parameter — Step id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Response upload payload
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.bot_response_upload+jsonapplication/vnd.goa.error
Responses
201
Object created
Bot_response_upload
400
Bad Request
error
404
Not Found
Up
patch /0.0.1/quriobot/responses/{id}
update quriobot_responses (quriobotResponsesUpdate)
Update response
Path parameters
id (required)
Path Parameter — Response id
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Body Parameter — Response create payload
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
403
Forbidden
Up
post /0.0.1/quriobot/ses/events
create quriobot_ses (quriobotSesCreate)
Create SES event
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.error
Responses
204
No Content
400
Bad Request
error
Up
get /0.0.1/website/terms/{id}
show website_terms (websiteTermsShow)
Terms
Path parameters
id (required)
Path Parameter — Backoffice user registration ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/jsontext/plain
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.goa.errorapplication/vnd.terms_file+json
Responses
200
OK
Terms_file
400
Bad Request
error
404
Not Found
[ Jump to Methods ]
Table of Contents
Agent - Mediatype identifier: application/vnd.agent+json; view=defaultAgentCollectionPayload - AgentCollectionPayloadAgentGroupCollectionPayload - AgentGroupCollectionPayloadAgentGroupMemberPayload - AgentGroupMemberPayloadAgentGroupPayload - AgentGroupPayloadAgentPayload - AgentPayloadAgentReference - Mediatype identifier: application/vnd.agent+json; view=referenceAgent_collection - Mediatype identifier: application/vnd.agent_collection+json; view=defaultAgent_group - Mediatype identifier: application/vnd.agent_group+json; view=defaultAgent_groupReference - Mediatype identifier: application/vnd.agent_group+json; view=referenceAgent_group_collection - Mediatype identifier: application/vnd.agent_group_collection+json; view=defaultAnimationPattern - AnimationPatternAnimationTiming - AnimationTimingAnnotatedLink - AnnotatedLinkApi_configuration - Mediatype identifier: application/vnd.api_configuration+json; view=defaultAuthorized - Mediatype identifier: application/vnd.authorized+json; view=defaultAutoCompleteItemCollectionPayload - AutoCompleteItemCollectionPayloadAutocomplete_item - Mediatype identifier: application/vnd.autocomplete_item+json; view=defaultAutocomplete_item_collection - Mediatype identifier: application/vnd.autocomplete_item_collection+json; view=defaultAzureCognitiveServicesSpeechIntegration - AzureCognitiveServicesSpeechIntegrationAzureCognitiveServicesSpeechIntegrationPayload - AzureCognitiveServicesSpeechIntegrationPayloadBehaviourConditionField - BehaviourConditionFieldBillingSettingsPayload - BillingSettingsPayloadBillingSettingsPaymentType - BillingSettingsPaymentTypeBoUserAPIKeyPayload - BoUserAPIKeyPayloadBoUserAPIKeyReference - BoUserAPIKeyReferenceBoUserAPIKeyReferenceCollectionPayload - BoUserAPIKeyReferenceCollectionPayloadBoUserCollectionPayload - BoUserCollectionPayloadBoUserCreatePayload - BoUserCreatePayloadBoUserExpoPushSubscriptionPayload - BoUserExpoPushSubscriptionPayloadBoUserInviteAcceptPayload - BoUserInviteAcceptPayloadBoUserInviteActionPayload - BoUserInviteActionPayloadBoUserInviteCollectionPayload - BoUserInviteCollectionPayloadBoUserInviteCreatePayload - BoUserInviteCreatePayloadBoUserOAuth - BoUserOAuthBoUserOAuthConfirmPayload - BoUserOAuthConfirmPayloadBoUserPushSubscriptionCollectionPayload - BoUserPushSubscriptionCollectionPayloadBoUserPushSubscriptionPayload - BoUserPushSubscriptionPayloadBoUserRegistrationConfirmationPayload - BoUserRegistrationConfirmationPayloadBoUserRegistrationPayload - BoUserRegistrationPayloadBoUserRole - BoUserRoleBoUserUpdatePayload - BoUserUpdatePayloadBo_user - Mediatype identifier: application/vnd.bo_user+json; view=defaultBo_userLink - Mediatype identifier: application/vnd.bo_user+json; view=linkBo_userReference - Mediatype identifier: application/vnd.bo_user+json; view=referenceBo_user_api_key - Mediatype identifier: application/vnd.bo_user_api_key+json; view=defaultBo_user_collection - Mediatype identifier: application/vnd.bo_user_collection+json; view=defaultBo_user_invite - Mediatype identifier: application/vnd.bo_user_invite+json; view=defaultBo_user_invite_collection - Mediatype identifier: application/vnd.bo_user_invite_collection+json; view=defaultBo_user_oauth_registration - Mediatype identifier: application/vnd.bo_user_oauth_registration+json; view=defaultBo_user_push_subscription - Mediatype identifier: application/vnd.bo_user_push_subscription+json; view=defaultBo_user_push_subscription_collection - Mediatype identifier: application/vnd.bo_user_push_subscription_collection+json; view=defaultBo_user_registration - Mediatype identifier: application/vnd.bo_user_registration+json; view=defaultBo_user_registrationCollection - Mediatype identifier: application/vnd.bo_user_registration+json; type=collection; view=defaultBo_user_username_change - Mediatype identifier: application/vnd.bo_user_username_change+json; view=defaultBo_userapi_key_reference_collection - Mediatype identifier: application/vnd.bo_userapi_key_reference_collection+json; view=defaultBot - Mediatype identifier: application/vnd.bot+json; view=defaultBotBatchUpdateCollectionPayload - BotBatchUpdateCollectionPayloadBotBatchUpdatePayload - BotBatchUpdatePayloadBotBehaviour - BotBehaviourBotBehaviourPayload - BotBehaviourPayloadBotChannelAudioTranscriptionSettings - BotChannelAudioTranscriptionSettingsBotChannelCollectionPayload - BotChannelCollectionPayloadBotChannelConfigFacebook - BotChannelConfigFacebookBotChannelConfigFacebookPage - BotChannelConfigFacebookPageBotChannelConfigGoogleBusinessMessages - BotChannelConfigGoogleBusinessMessagesBotChannelConfigGoogleBusinessMessagesAccount - BotChannelConfigGoogleBusinessMessagesAccountBotChannelConfigInstagram - BotChannelConfigInstagramBotChannelConfigInstagramAccount - BotChannelConfigInstagramAccountBotChannelMessageBirdType - BotChannelMessageBirdTypeBotChannelPayload - BotChannelPayloadBotChannelStatus - BotChannelStatusBotChannelTestUrl - BotChannelTestUrlBotChannelTextToSpeechSettings - BotChannelTextToSpeechSettingsBotChannelTrigger - BotChannelTriggerBotChannelType - BotChannelTypeBotChatStepAnswerPayload - BotChatStepAnswerPayloadBotChatStepOptionCollectionPayload - BotChatStepOptionCollectionPayloadBotChatStepTextFeedbackPayload - BotChatStepTextFeedbackPayloadBotChatText - BotChatTextBotChatTextPayload - BotChatTextPayloadBotChatTextType - BotChatTextTypeBotCollectionPayload - BotCollectionPayloadBotCreatePayload - BotCreatePayloadBotDropOffReportPayload - BotDropOffReportPayloadBotEditMode - BotEditModeBotEditPosition - BotEditPositionBotFeedbackReportItem - BotFeedbackReportItemBotFeedbackReportPayload - BotFeedbackReportPayloadBotFrontend - BotFrontendBotFrontendAMP - BotFrontendAMPBotFunnelReportItem - BotFunnelReportItemBotFunnelReportPayload - BotFunnelReportPayloadBotInteractiveReportOption - BotInteractiveReportOptionBotInteractiveReportPayload - BotInteractiveReportPayloadBotInteractiveReportPayloadItem - BotInteractiveReportPayloadItemBotInteractiveReportStep - BotInteractiveReportStepBotLandingPage - BotLandingPageBotLandingPageBackground - BotLandingPageBackgroundBotLiveChat - BotLiveChatBotLiveChatPayload - BotLiveChatPayloadBotLiveChatType - BotLiveChatTypeBotLocationReportItem - BotLocationReportItemBotLocationReportPayload - BotLocationReportPayloadBotMessageDelay - BotMessageDelayBotMonitoringChannelItem - BotMonitoringChannelItemBotMonitoringDeviceItem - BotMonitoringDeviceItemBotMonitoringHostnameItem - BotMonitoringHostnameItemBotMonitoringItem - BotMonitoringItemBotMonitoringOverallItem - BotMonitoringOverallItemBotMonitoringReportItem - BotMonitoringReportItemBotMonitoringReportPayload - BotMonitoringReportPayloadBotNextTargetType - BotNextTargetTypeBotNotification - BotNotificationBotNotificationPayload - BotNotificationPayloadBotOffset - BotOffsetBotOffsetPayload - BotOffsetPayloadBotPersistentMenu - BotPersistentMenuBotPersistentMenuItem - BotPersistentMenuItemBotPosition - BotPositionBotPreview - Mediatype identifier: application/vnd.bot+json; view=previewBotPreviewPayload - BotPreviewPayloadBotProgressReportItem - BotProgressReportItemBotProgressReportPayload - BotProgressReportPayloadBotReference - Mediatype identifier: application/vnd.bot+json; view=referenceBotReferenceType - BotReferenceTypeBotReporting - Mediatype identifier: application/vnd.bot+json; view=reportingBotReportingTokenPayload - BotReportingTokenPayloadBotResponseAction - BotResponseActionBotResponseActionEmailTemplateType - BotResponseActionEmailTemplateTypeBotResponseActionHeader - BotResponseActionHeaderBotResponseActionHeaderPayload - BotResponseActionHeaderPayloadBotResponseActionLogItemCollectionPayload - BotResponseActionLogItemCollectionPayloadBotResponseActionLogItemReferenceType - BotResponseActionLogItemReferenceTypeBotResponseActionPayload - BotResponseActionPayloadBotResponseActionType - BotResponseActionTypeBotResponseCollectionPayload - BotResponseCollectionPayloadBotResponseDeletePayload - BotResponseDeletePayloadBotStartPayload - BotStartPayloadBotStatsChannelItem - BotStatsChannelItemBotStatsDeviceItem - BotStatsDeviceItemBotStatsExitItem - BotStatsExitItemBotStatsItem - BotStatsItemBotStatsOverallItem - BotStatsOverallItemBotStatsReportPayload - BotStatsReportPayloadBotStatsStepItem - BotStatsStepItemBotStatus - BotStatusBotStep - BotStepBotStepDisplayType - BotStepDisplayTypeBotStepLocationType - BotStepLocationTypeBotStepNext - BotStepNextBotStepOption - BotStepOptionBotStepOptionPayload - BotStepOptionPayloadBotStepOptionsLayout - BotStepOptionsLayoutBotStepPayload - BotStepPayloadBotStepRatingType - BotStepRatingTypeBotStepResponse - BotStepResponseBotStepResponsePayload - BotStepResponsePayloadBotStepResponseType - BotStepResponseTypeBotStepType - BotStepTypeBotTemplateCollectionPayload - BotTemplateCollectionPayloadBotTemplateGroup - BotTemplateGroupBotTheme - BotThemeBotThemeAvatar - BotThemeAvatarBotThemeBehaviour - BotThemeBehaviourBotThemeBehaviourPayload - BotThemeBehaviourPayloadBotThemePayload - BotThemePayloadBotTransferPayload - BotTransferPayloadBotType - BotTypeBotUpdatePayload - BotUpdatePayloadBotVariable - BotVariableBotVariableChatCompletion - BotVariableChatCompletionBotVariableLogItemCollectionPayload - BotVariableLogItemCollectionPayloadBotVariablePayload - BotVariablePayloadBotVariableTextToSpeech - BotVariableTextToSpeechBotVariableType - BotVariableTypeBotViewMode - BotViewModeBot_batch_update - Mediatype identifier: application/vnd.bot_batch_update+json; view=defaultBot_batch_update_collection - Mediatype identifier: application/vnd.bot_batch_update_collection+json; view=defaultBot_channel - Mediatype identifier: application/vnd.bot_channel+json; view=defaultBot_channelReference - Mediatype identifier: application/vnd.bot_channel+json; view=referenceBot_channel_collection - Mediatype identifier: application/vnd.bot_channel_collection+json; view=defaultBot_channel_config - Mediatype identifier: application/vnd.bot_channel_config+json; view=defaultBot_channel_preview - Mediatype identifier: application/vnd.bot_channel_preview+json; view=defaultBot_chat_step - Mediatype identifier: application/vnd.bot_chat_step+json; view=defaultBot_chat_step_option - Mediatype identifier: application/vnd.bot_chat_step_option+json; view=defaultBot_chat_step_option_collection - Mediatype identifier: application/vnd.bot_chat_step_option_collection+json; view=defaultBot_chat_variable - Mediatype identifier: application/vnd.bot_chat_variable+json; view=defaultBot_collection - Mediatype identifier: application/vnd.bot_collection+json; view=defaultBot_drop_off_report - Mediatype identifier: application/vnd.bot_drop_off_report+json; view=defaultBot_feedback_report - Mediatype identifier: application/vnd.bot_feedback_report+json; view=defaultBot_funnel_report - Mediatype identifier: application/vnd.bot_funnel_report+json; view=defaultBot_interactive_report - Mediatype identifier: application/vnd.bot_interactive_report+json; view=defaultBot_location_report - Mediatype identifier: application/vnd.bot_location_report+json; view=defaultBot_monitoring_report - Mediatype identifier: application/vnd.bot_monitoring_report+json; view=defaultBot_progress_report - Mediatype identifier: application/vnd.bot_progress_report+json; view=defaultBot_response - Mediatype identifier: application/vnd.bot_response+json; view=defaultBot_responseReference - Mediatype identifier: application/vnd.bot_response+json; view=referenceBot_response_action_log_item - Mediatype identifier: application/vnd.bot_response_action_log_item+json; view=defaultBot_response_action_log_item_collection - Mediatype identifier: application/vnd.bot_response_action_log_item_collection+json; view=defaultBot_response_collection - Mediatype identifier: application/vnd.bot_response_collection+json; view=defaultBot_response_upload - Mediatype identifier: application/vnd.bot_response_upload+json; view=defaultBot_stats - Mediatype identifier: application/vnd.bot_stats+json; view=defaultBot_variable_log_item - Mediatype identifier: application/vnd.bot_variable_log_item+json; view=defaultBot_variable_log_item_collection - Mediatype identifier: application/vnd.bot_variable_log_item_collection+json; view=defaultCampaign - Mediatype identifier: application/vnd.campaign+json; view=defaultCampaignAutomationRule - CampaignAutomationRuleCampaignAutomationRuleAction - CampaignAutomationRuleActionCampaignAutomationRuleActionLogItemCollectionPayload - CampaignAutomationRuleActionLogItemCollectionPayloadCampaignAutomationRuleActionSendMessage - CampaignAutomationRuleActionSendMessageCampaignAutomationRuleConditionField - CampaignAutomationRuleConditionFieldCampaignAutomationRuleConditionOperator - CampaignAutomationRuleConditionOperatorCampaignAutomationRuleReference - CampaignAutomationRuleReferenceCampaignCollectionPayload - CampaignCollectionPayloadCampaignDeletePayload - CampaignDeletePayloadCampaignMessage - CampaignMessageCampaignPayload - CampaignPayloadCampaignSendPayload - CampaignSendPayloadCampaign_automation_rule_action_log_item - Mediatype identifier: application/vnd.campaign_automation_rule_action_log_item+json; view=defaultCampaign_automation_rule_action_log_item_collection - Mediatype identifier: application/vnd.campaign_automation_rule_action_log_item_collection+json; view=defaultCampaign_collection - Mediatype identifier: application/vnd.campaign_collection+json; view=defaultChatContactCollectionPayload - ChatContactCollectionPayloadChatContactDeletePayload - ChatContactDeletePayloadChatContactPayload - ChatContactPayloadChat_contact - Mediatype identifier: application/vnd.chat_contact+json; view=defaultChat_contact_collection - Mediatype identifier: application/vnd.chat_contact_collection+json; view=defaultCurrency - CurrencyCustomSubscriptionBillPayload - CustomSubscriptionBillPayloadCustomSubscriptionChatPackagePayload - CustomSubscriptionChatPackagePayloadCustomSubscriptionOrderPayload - CustomSubscriptionOrderPayloadCustomSubscriptionPlanPayload - CustomSubscriptionPlanPayloadCustomSubscriptionVoucherGroupPayload - CustomSubscriptionVoucherGroupPayloadDNSRecord - DNSRecordDimensions - DimensionsDomain - Mediatype identifier: application/vnd.domain+json; view=defaultDomainCollectionPayload - DomainCollectionPayloadDomainCreatePayload - DomainCreatePayloadDomainStatus - DomainStatusDomainType - DomainTypeDomain_collection - Mediatype identifier: application/vnd.domain_collection+json; view=defaultDownload - Mediatype identifier: application/vnd.download+json; view=defaultDownloadCollectionPayload - DownloadCollectionPayloadDownloadDeletePayload - DownloadDeletePayloadDownload_collection - Mediatype identifier: application/vnd.download_collection+json; view=defaultEmailAddress - EmailAddressEmailAddressCreatePayload - EmailAddressCreatePayloadEmailAddressUpdatePayload - EmailAddressUpdatePayloadEmailFromAddressStatus - EmailFromAddressStatusEmailSettings - EmailSettingsEmailSettingsPayload - EmailSettingsPayloadEmail_from_address - Mediatype identifier: application/vnd.email_from_address+json; view=defaultEmail_from_address_collection - Mediatype identifier: application/vnd.email_from_address_collection+json; view=defaultEmail_replyto_address - Mediatype identifier: application/vnd.email_replyto_address+json; view=defaultEmail_replyto_address_collection - Mediatype identifier: application/vnd.email_replyto_address_collection+json; view=defaultFontSizePayload - FontSizePayloadFormBodyValue - FormBodyValueFormContentType - FormContentTypeFreshdeskIntegration - FreshdeskIntegrationFreshdeskIntegrationPayload - FreshdeskIntegrationPayloadFrontend_bot_chat_text - Mediatype identifier: application/vnd.frontend_bot_chat_text+json; view=defaultGender - GenderGoogleDriveIntegration - GoogleDriveIntegrationGoogleDriveIntegrationPayload - GoogleDriveIntegrationPayloadIntegration - Mediatype identifier: application/vnd.integration+json; view=defaultIntegrationCollectionPayload - IntegrationCollectionPayloadIntegrationConfigAzureCognitiveServicesSpeech - IntegrationConfigAzureCognitiveServicesSpeechIntegrationConfigFreshdesk - IntegrationConfigFreshdeskIntegrationConfigGoogleDrive - IntegrationConfigGoogleDriveIntegrationConfigOpenAI - IntegrationConfigOpenAIIntegrationCreatePayload - IntegrationCreatePayloadIntegrationReference - Mediatype identifier: application/vnd.integration+json; view=referenceIntegrationStatus - IntegrationStatusIntegrationType - IntegrationTypeIntegrationTypeCategory - IntegrationTypeCategoryIntegrationTypeCollectionPayload - IntegrationTypeCollectionPayloadIntegrationTypeFeature - IntegrationTypeFeatureIntegrationTypeTag - IntegrationTypeTagIntegrationUpdatePayload - IntegrationUpdatePayloadIntegration_collection - Mediatype identifier: application/vnd.integration_collection+json; view=defaultIntegration_config - Mediatype identifier: application/vnd.integration_config+json; view=defaultIntegration_type_collection - Mediatype identifier: application/vnd.integration_type_collection+json; view=defaultKnowledgeBaseArticleCollectionPayload - KnowledgeBaseArticleCollectionPayloadKnowledgeBaseArticleDeletePayload - KnowledgeBaseArticleDeletePayloadKnowledgeBaseArticlePayload - KnowledgeBaseArticlePayloadKnowledgeBaseArticleReplacePayload - KnowledgeBaseArticleReplacePayloadKnowledgeBaseArticleResource - KnowledgeBaseArticleResourceKnowledgeBaseCollectionPayload - KnowledgeBaseCollectionPayloadKnowledgeBaseImportCollectionPayload - KnowledgeBaseImportCollectionPayloadKnowledgeBaseImportFreshdesk - KnowledgeBaseImportFreshdeskKnowledgeBaseImportPayload - KnowledgeBaseImportPayloadKnowledgeBaseImportStatus - KnowledgeBaseImportStatusKnowledgeBaseMenuItem - KnowledgeBaseMenuItemKnowledgeBasePayload - KnowledgeBasePayloadKnowledgeBaseSearchPayload - KnowledgeBaseSearchPayloadKnowledgeBaseSection - KnowledgeBaseSectionKnowledgeBaseStatus - KnowledgeBaseStatusKnowledge_base - Mediatype identifier: application/vnd.knowledge_base+json; view=defaultKnowledge_baseReference - Mediatype identifier: application/vnd.knowledge_base+json; view=referenceKnowledge_base_article - Mediatype identifier: application/vnd.knowledge_base_article+json; view=defaultKnowledge_base_article_collection - Mediatype identifier: application/vnd.knowledge_base_article_collection+json; view=defaultKnowledge_base_collection - Mediatype identifier: application/vnd.knowledge_base_collection+json; view=defaultKnowledge_base_import - Mediatype identifier: application/vnd.knowledge_base_import+json; view=defaultKnowledge_base_import_collection - Mediatype identifier: application/vnd.knowledge_base_import_collection+json; view=defaultKnowledge_base_search_result_item - Mediatype identifier: application/vnd.knowledge_base_search_result_item+json; view=defaultKnowledge_base_search_result_item_collection - Mediatype identifier: application/vnd.knowledge_base_search_result_item_collection+json; view=defaultLanguage - LanguageLinkTarget - LinkTargetLiveChatAssignPayload - LiveChatAssignPayloadLiveChatAttachmentAudioTranscriptionSettings - LiveChatAttachmentAudioTranscriptionSettingsLiveChatAttachmentPayload - LiveChatAttachmentPayloadLiveChatAttachmentSettings - LiveChatAttachmentSettingsLiveChatAutomationRule - LiveChatAutomationRuleLiveChatAutomationRuleAction - LiveChatAutomationRuleActionLiveChatAutomationRuleActionHeader - LiveChatAutomationRuleActionHeaderLiveChatAutomationRuleActionLogItemCollectionPayload - LiveChatAutomationRuleActionLogItemCollectionPayloadLiveChatAutomationRuleActionLogItemReferenceType - LiveChatAutomationRuleActionLogItemReferenceTypeLiveChatAutomationRuleConditionField - LiveChatAutomationRuleConditionFieldLiveChatAutomationRuleConditionOperator - LiveChatAutomationRuleConditionOperatorLiveChatAutomationRuleReference - LiveChatAutomationRuleReferenceLiveChatCannedResponseCollectionPayload - LiveChatCannedResponseCollectionPayloadLiveChatCannedResponsePayload - LiveChatCannedResponsePayloadLiveChatCannedResponseRenderPayload - LiveChatCannedResponseRenderPayloadLiveChatChannelModePayload - LiveChatChannelModePayloadLiveChatCollectionPayload - LiveChatCollectionPayloadLiveChatImportCollectionPayload - LiveChatImportCollectionPayloadLiveChatImportFreshdesk - LiveChatImportFreshdeskLiveChatImportPayload - LiveChatImportPayloadLiveChatImportStatus - LiveChatImportStatusLiveChatMergePayload - LiveChatMergePayloadLiveChatMessageCollectionPayload - LiveChatMessageCollectionPayloadLiveChatMessagePayload - LiveChatMessagePayloadLiveChatPayload - LiveChatPayloadLiveChatReference - LiveChatReferenceLiveChatSearchViewCollectionPayload - LiveChatSearchViewCollectionPayloadLiveChatSearchViewPayload - LiveChatSearchViewPayloadLiveChatSettings - LiveChatSettingsLiveChatTranslationModePayload - LiveChatTranslationModePayloadLiveChatUpdateCollectionPayload - LiveChatUpdateCollectionPayloadLive_chat - Mediatype identifier: application/vnd.live_chat+json; view=defaultLive_chat_attachment - Mediatype identifier: application/vnd.live_chat_attachment+json; view=defaultLive_chat_automation_rule_action_log_item - Mediatype identifier: application/vnd.live_chat_automation_rule_action_log_item+json; view=defaultLive_chat_automation_rule_action_log_item_collection - Mediatype identifier: application/vnd.live_chat_automation_rule_action_log_item_collection+json; view=defaultLive_chat_canned_response - Mediatype identifier: application/vnd.live_chat_canned_response+json; view=defaultLive_chat_canned_response_collection - Mediatype identifier: application/vnd.live_chat_canned_response_collection+json; view=defaultLive_chat_collection - Mediatype identifier: application/vnd.live_chat_collection+json; view=defaultLive_chat_import - Mediatype identifier: application/vnd.live_chat_import+json; view=defaultLive_chat_import_collection - Mediatype identifier: application/vnd.live_chat_import_collection+json; view=defaultLive_chat_message - Mediatype identifier: application/vnd.live_chat_message+json; view=defaultLive_chat_message_collection - Mediatype identifier: application/vnd.live_chat_message_collection+json; view=defaultLive_chat_search_view - Mediatype identifier: application/vnd.live_chat_search_view+json; view=defaultLive_chat_search_view_collection - Mediatype identifier: application/vnd.live_chat_search_view_collection+json; view=defaultLock - Mediatype identifier: application/vnd.lock+json; view=defaultLockDeletePayload - LockDeletePayloadLockPayload - LockPayloadLoginBackofficeAuthPayload - LoginBackofficeAuthPayloadLoginOAuthCallbackConfirmPayload - LoginOAuthCallbackConfirmPayloadLoginOauthPayload - LoginOauthPayloadLoginProvider - LoginProviderLoginTokenBackofficeAuthPayload - LoginTokenBackofficeAuthPayloadMailPayload - MailPayloadNotificationSettings - NotificationSettingsNotificationSettingsPayload - NotificationSettingsPayloadNotificationTemplate - NotificationTemplateObjectVersionCollectionPayload - ObjectVersionCollectionPayloadObjectVersionCreatePayload - ObjectVersionCreatePayloadObject_version - Mediatype identifier: application/vnd.object_version+json; view=defaultObject_version_collection - Mediatype identifier: application/vnd.object_version_collection+json; view=defaultOffset - OffsetOffsetPayload - OffsetPayloadOffsetUnit - OffsetUnitOpenAIIntegration - OpenAIIntegrationOpenAIIntegrationAutomationRule - OpenAIIntegrationAutomationRuleOpenAIIntegrationAutomationRuleAction - OpenAIIntegrationAutomationRuleActionOpenAIIntegrationAutomationRuleActionCrawlUpdateAssistant - OpenAIIntegrationAutomationRuleActionCrawlUpdateAssistantOpenAIIntegrationAutomationRuleActionGoogleDriveSpreadsheetUpdateAssistant - OpenAIIntegrationAutomationRuleActionGoogleDriveSpreadsheetUpdateAssistantOpenAIIntegrationAutomationRuleActionLogItemCollectionPayload - OpenAIIntegrationAutomationRuleActionLogItemCollectionPayloadOpenAIIntegrationAutomationRuleActionResponseAssessment - OpenAIIntegrationAutomationRuleActionResponseAssessmentOpenAIIntegrationAutomationRuleConditionField - OpenAIIntegrationAutomationRuleConditionFieldOpenAIIntegrationAutomationRuleConditionOperator - OpenAIIntegrationAutomationRuleConditionOperatorOpenAIIntegrationAutomationRuleReference - OpenAIIntegrationAutomationRuleReferenceOpenAIIntegrationPayload - OpenAIIntegrationPayloadOpen_ai_integration_automation_rule_action_log_item - Mediatype identifier: application/vnd.open_ai_integration_automation_rule_action_log_item+json; view=defaultOpen_ai_integration_automation_rule_action_log_item_collection - Mediatype identifier: application/vnd.open_ai_integration_automation_rule_action_log_item_collection+json; view=defaultOptionalTranslation - OptionalTranslationOrganisation - Mediatype identifier: application/vnd.organisation+json; view=defaultOrganisationActivateCallback - OrganisationActivateCallbackOrganisationActivatePayload - OrganisationActivatePayloadOrganisationCollectionPayload - OrganisationCollectionPayloadOrganisationCreatePayload - OrganisationCreatePayloadOrganisationDeactivatePayload - OrganisationDeactivatePayloadOrganisationMemberSettingsLiveChat - OrganisationMemberSettingsLiveChatOrganisationMemberSettingsLiveChatList - OrganisationMemberSettingsLiveChatListOrganisationMemberSettingsPayload - OrganisationMemberSettingsPayloadOrganisationMembershipCollectionPayload - OrganisationMembershipCollectionPayloadOrganisationMembershipRole - OrganisationMembershipRoleOrganisationMembershipUpdatePayload - OrganisationMembershipUpdatePayloadOrganisationReference - Mediatype identifier: application/vnd.organisation+json; view=referenceOrganisationReferralPaymentCollectionPayload - OrganisationReferralPaymentCollectionPayloadOrganisationReferralPaymentPayload - OrganisationReferralPaymentPayloadOrganisationSubscriptionStatus - OrganisationSubscriptionStatusOrganisationSubscriptionUsage - OrganisationSubscriptionUsageOrganisationUpdatePayload - OrganisationUpdatePayloadOrganisation_activation_result - Mediatype identifier: application/vnd.organisation_activation_result+json; view=defaultOrganisation_billing_settings - Mediatype identifier: application/vnd.organisation_billing_settings+json; view=defaultOrganisation_collection - Mediatype identifier: application/vnd.organisation_collection+json; view=defaultOrganisation_member_settings - Mediatype identifier: application/vnd.organisation_member_settings+json; view=defaultOrganisation_membership - Mediatype identifier: application/vnd.organisation_membership+json; view=defaultOrganisation_membershipReference - Mediatype identifier: application/vnd.organisation_membership+json; view=referenceOrganisation_membership_collection - Mediatype identifier: application/vnd.organisation_membership_collection+json; view=defaultOrganisation_referral - Mediatype identifier: application/vnd.organisation_referral+json; view=defaultOrganisation_referral_payment - Mediatype identifier: application/vnd.organisation_referral_payment+json; view=defaultOrganisation_referral_payment_collection - Mediatype identifier: application/vnd.organisation_referral_payment_collection+json; view=defaultOrganisation_subscription - Mediatype identifier: application/vnd.organisation_subscription+json; view=defaultOrganisation_subscriptionReference - Mediatype identifier: application/vnd.organisation_subscription+json; view=referencePasswordScorePayload - PasswordScorePayloadPassword_score - Mediatype identifier: application/vnd.password_score+json; view=defaultPayment - Mediatype identifier: application/vnd.payment+json; view=defaultPaymentCollectionPayload - PaymentCollectionPayloadPaymentCreatePayload - PaymentCreatePayloadPaymentMandateStatus - PaymentMandateStatusPaymentMethod - PaymentMethodPaymentPurpose - PaymentPurposePaymentRecurringType - PaymentRecurringTypePaymentStatus - PaymentStatusPaymentUpdateStatusPayload - PaymentUpdateStatusPayloadPayment_collection - Mediatype identifier: application/vnd.payment_collection+json; view=defaultPayment_mandate - Mediatype identifier: application/vnd.payment_mandate+json; view=defaultPayment_mandate_collection - Mediatype identifier: application/vnd.payment_mandate_collection+json; view=defaultPermission - PermissionPoint - PointPostInitBehaviourConditionField - PostInitBehaviourConditionFieldPrivacyTerms - PrivacyTermsRecaptcha - Mediatype identifier: application/vnd.recaptcha+json; view=defaultReputationStatus - ReputationStatusRequestPasswordResetConfirmPayload - RequestPasswordResetConfirmPayloadRequestPasswordResetRequestPayload - RequestPasswordResetRequestPayloadRequestUsernameChangeConfirmPayload - RequestUsernameChangeConfirmPayloadRequestUsernameChangeRequestPayload - RequestUsernameChangeRequestPayloadResponseCreatePayload - ResponseCreatePayloadResponseUploadPayload - ResponseUploadPayloadSESNotification - SESNotificationSoundNotification - SoundNotificationStickyAvatarAnimation - StickyAvatarAnimationStickyAvatarAnimationPayload - StickyAvatarAnimationPayloadStickyAvatarOffset - StickyAvatarOffsetStickyAvatarOffsetPayload - StickyAvatarOffsetPayloadStickyAvatarPopup - StickyAvatarPopupStickyAvatarPopupBehaviour - StickyAvatarPopupBehaviourSubscriber - Mediatype identifier: application/vnd.subscriber+json; view=defaultSubscriberCollectionPayload - SubscriberCollectionPayloadSubscriberDeletePayload - SubscriberDeletePayloadSubscriberGroupCollectionPayload - SubscriberGroupCollectionPayloadSubscriberGroupDeletePayload - SubscriberGroupDeletePayloadSubscriberGroupPayload - SubscriberGroupPayloadSubscriber_collection - Mediatype identifier: application/vnd.subscriber_collection+json; view=defaultSubscriber_group - Mediatype identifier: application/vnd.subscriber_group+json; view=defaultSubscriber_group_collection - Mediatype identifier: application/vnd.subscriber_group_collection+json; view=defaultSubscriptionBillPayload - SubscriptionBillPayloadSubscriptionBillPlan - SubscriptionBillPlanSubscriptionInvoiceBillPayload - SubscriptionInvoiceBillPayloadSubscriptionInvoiceCollectionPayload - SubscriptionInvoiceCollectionPayloadSubscriptionInvoiceRerenderPayload - SubscriptionInvoiceRerenderPayloadSubscriptionInvoiceRetryFailedPaymentsPayload - SubscriptionInvoiceRetryFailedPaymentsPayloadSubscriptionInvoiceStatus - SubscriptionInvoiceStatusSubscriptionInvoiceUpdateCollectionPayload - SubscriptionInvoiceUpdateCollectionPayloadSubscriptionInvoiceUpdatePayload - SubscriptionInvoiceUpdatePayloadSubscriptionOrderCheckoutPayload - SubscriptionOrderCheckoutPayloadSubscriptionOrderCollectionPayload - SubscriptionOrderCollectionPayloadSubscriptionOrderPayload - SubscriptionOrderPayloadSubscriptionOrderStatus - SubscriptionOrderStatusSubscriptionOrderUpdatePayload - SubscriptionOrderUpdatePayloadSubscriptionPeriod - SubscriptionPeriodSubscriptionPlanChatPackage - SubscriptionPlanChatPackageSubscriptionPlanChatPackageCollection - SubscriptionPlanChatPackageCollectionSubscriptionPlanFeature - SubscriptionPlanFeatureSubscriptionQuotaStatus - SubscriptionQuotaStatusSubscriptionVoucherCollectionPayload - SubscriptionVoucherCollectionPayloadSubscriptionVoucherGroupCollectionPayload - SubscriptionVoucherGroupCollectionPayloadSubscriptionVoucherGroupPayload - SubscriptionVoucherGroupPayloadSubscriptionVoucherGroupStatus - SubscriptionVoucherGroupStatusSubscription_bill - Mediatype identifier: application/vnd.subscription_bill+json; view=defaultSubscription_invoice - Mediatype identifier: application/vnd.subscription_invoice+json; view=defaultSubscription_invoiceReference - Mediatype identifier: application/vnd.subscription_invoice+json; view=referenceSubscription_invoice_bill - Mediatype identifier: application/vnd.subscription_invoice_bill+json; view=defaultSubscription_invoice_bill_item - Mediatype identifier: application/vnd.subscription_invoice_bill_item+json; view=defaultSubscription_invoice_collection - Mediatype identifier: application/vnd.subscription_invoice_collection+json; view=defaultSubscription_invoice_item - Mediatype identifier: application/vnd.subscription_invoice_item+json; view=defaultSubscription_order - Mediatype identifier: application/vnd.subscription_order+json; view=defaultSubscription_orderReference - Mediatype identifier: application/vnd.subscription_order+json; view=referenceSubscription_order_collection - Mediatype identifier: application/vnd.subscription_order_collection+json; view=defaultSubscription_plan - Mediatype identifier: application/vnd.subscription_plan+json; view=defaultSubscription_planReference - Mediatype identifier: application/vnd.subscription_plan+json; view=referenceSubscription_plan_collection - Mediatype identifier: application/vnd.subscription_plan_collection+json; view=defaultSubscription_voucher - Mediatype identifier: application/vnd.subscription_voucher+json; view=defaultSubscription_voucher_collection - Mediatype identifier: application/vnd.subscription_voucher_collection+json; view=defaultSubscription_voucher_group - Mediatype identifier: application/vnd.subscription_voucher_group+json; view=defaultSubscription_voucher_groupReference - Mediatype identifier: application/vnd.subscription_voucher_group+json; view=referenceSubscription_voucher_group_collection - Mediatype identifier: application/vnd.subscription_voucher_group_collection+json; view=defaultTableColumn - TableColumnTerms_file - Mediatype identifier: application/vnd.terms_file+json; view=defaultTranslation - TranslationTriggerConditionField - TriggerConditionFieldTriggerConditionOperator - TriggerConditionOperatorTwitter_events_verify_response - Mediatype identifier: application/vnd.twitter_events_verify_response+json; view=defaultUsageItem - UsageItemVisitorDevice - VisitorDeviceerror - Mediatype identifier: application/vnd.goa.error; view=default
Agent (default view)
avatar (optional)
bot (optional)
chat (optional)
created_at
Date Date of creation format: date-time
email (optional)
first_name (optional)
groups (optional)
id
last_name (optional)
organisation (optional)
status
away
online
invisible
updated_at (optional)
Date Date of update format: date-time
user (optional)
Agent collection payload
group (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
status (optional)
Agent group collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Agent group member payload
Agent group payload
description (optional)
name
Agent payload
avatar (optional)
first_name (optional)
last_name (optional)
status (optional)
away
online
invisible
user (optional)
Agent (reference view)
avatar (optional)
email (optional)
first_name (optional)
id
last_name (optional)
status
away
online
invisible
agent collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Agent group (default view)
created_at
Date Date of creation format: date-time
description (optional)
id
name
organisation
updated_at (optional)
Date Date of update format: date-time
Agent group (reference view)
agent_group collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Animation pattern
description (optional)
id
0
1
2
3
4
5
6
7
10
11
12
name (optional)
value
fade_in_out
horizontal_flipping
vertical_flipping
horizontal_appearing
vertical_appearing
horizontal_3d_rotation
vertical_3d_rotation
explosion
barrel_roll
zoom_in_out
zoom_and_rotate
Animation timing
description (optional)
id
0
1
2
3
4
5
name (optional)
value
ease
ease_in
ease_out
ease_in_out
linear
cubic_bezier
API configuration (default view)
backoffice_url
graphql_cognito_identity_pool_id
graphql_url
An authorized response (default view)
expires_at
Date JWT token expiration time format: date-time
token
user
Auto complete item collection payload
agent_groups (optional)
enum (optional)
CampaignAutomationRuleActionTypes
OpenAIIntegrationAutomationRuleTriggerTypes
OpenAIIntegrationAutomationRuleActionTypes
OpenAIIntegrationAutomationRuleActionVariables
OpenAIIntegrationAutomationRuleCrawlUpdateAssistantFormats
OpenAIIntegrationAutomationRuleActionResponseAssessmentPeriods
CampaignAutomationRuleActionVariables
IntegrationType
OpenAIIntegrationVoices
CampaignAutomationRuleTriggerTypes
ids (optional)
integration_type_features (optional)
knowledge_base_categories (optional)
knowledge_base_tags (optional)
live_chat_canned_response_categories (optional)
page_number (optional)
page_size (optional)
search (optional)
Autocomplete item (default view)
description (optional)
icon (optional)
id
text
autocomplete_item collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Azure cognitive services speech integration
Azure cognitive services speech integration payload
Bot behaviour condition fields
description (optional)
id
0
10
11
1
2
3
4
5
6
7
8
9
12
13
14
15
name (optional)
value
ip
country
city
pageHostName
pagePath
pageURL
referrer
dayOfWeek
time
deviceType
day
month
isReturning
visitCount
state
continent
Organisation billing settings payload
auto_chat_package (optional)
Boolean Adjust chat package automatically
payer (optional)
payment_mandate_id (optional)
String Selected payment mandate id
payment_type (optional)
standard
external
Billing settings payment type
description (optional)
id
0
1
name (optional)
value
standard
external
Backoffice user API key payload
Backoffice user API key payload
created_at
Date Date of creation format: date-time
id
name
updated_at (optional)
Date Date of update format: date-time
A backoffice user API key reference collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
User collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
A backoffice user payload
email
String Email of backoffice user format: email
first_name
String Firstname of backoffice user
gender (optional)
String Gender of backoffice user
male
female
language (optional)
cs-cz
de-de
en-us
es-es
fr-fr
it-it
nl-nl
pt-br
ru-ru
uk-ua
last_name
String Lastname of backoffice user
password
String Password of backoffice user
timezone (optional)
Backoffice user expo push subscription payload
expo_token
notification_enabled (optional)
sound_notification_enabled (optional)
user_agent
A backoffice user invite accept payload
email (optional)
String Email of backoffice user format: email
first_name (optional)
String Firstname of backoffice user
invite_code
is_accepted_toc (optional)
Boolean Flag whether a user had accepted T&C
last_name (optional)
String Lastname of backoffice user
password (optional)
String Password of backoffice user
recaptcha_response
Backoffice user invite action payload
ids (optional)
search (optional)
User invite collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Invite create payload
add_to_sub_organisations (optional)
email
String Email of backoffice user format: email
first_name
String Firstname of backoffice user
last_name
String Lastname of backoffice user
recaptcha_response
role
member
admin
read_only
agent
welcome_notification
Backoffice user oauth authorizatioon
created_at
Date Date of creation format: date-time
id
provider
provider_user_id
updated_at (optional)
Date Date of update format: date-time
A backoffice oauth user registration confirm payload
code
email
String Email of backoffice user format: email
first_name
String Firstname of backoffice user
is_accepted_dpa
Boolean Flag whether a user had accepted DPA
is_accepted_toc
Boolean Flag whether a user had accepted T&C
last_name
String Lastname of backoffice user
recaptcha_response
referral_code (optional)
voucher_code (optional)
String Optional subscripton voucher code
A backoffice user push subscription collection payload
endpoint (optional)
expo_token (optional)
notification_enabled (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
sound_notification_enabled (optional)
type (optional)
web
expo
Backoffice user push subscription payload
expo_token (optional)
notification_enabled (optional)
sound_notification_enabled (optional)
subscription (optional)
user_agent (optional)
A backoffice user registration confirmation payload
A backoffice user registration payload
email
String Email of backoffice user format: email
first_name
String Firstname of backoffice user
is_accepted_dpa
Boolean Flag whether a user had accepted DPA
is_accepted_toc
Boolean Flag whether a user had accepted T&C
last_name
String Lastname of backoffice user
password
String Password of backoffice user
recaptcha_response
referral_code (optional)
voucher_code (optional)
String Optional subscripton voucher code
Backoffice user role
description (optional)
id
1
0
2
name (optional)
value
admin
user
consumer
A backoffice user payload
avatar (optional)
email (optional)
String Email of backoffice user format: email
favorite_organisations (optional)
first_name (optional)
String Firstname of backoffice user
gender (optional)
String Gender of backoffice user
male
female
has_password (optional)
is_accepted_toc (optional)
Boolean Flag whether a user had accepted T&C
is_active (optional)
language (optional)
cs-cz
de-de
en-us
es-es
fr-fr
it-it
nl-nl
pt-br
ru-ru
uk-ua
last_name (optional)
String Lastname of backoffice user
password (optional)
String Password of backoffice user
timezone (optional)
A backoffice account (default view)
accepted_privacy (optional)
String Accepted Privacy Policy
accepted_toc (optional)
accepted_toc_at (optional)
Date Date and time when a user had accepted T&C format: date-time
agent (optional)
avatar (optional)
created_at
Date Date of creation format: date-time
deactivated_at (optional)
Date Date and time of user deactivation format: date-time
email
String Email of backoffice user format: email
favorite_organisations (optional)
first_name
String Firstname of backoffice user
gender (optional)
has_password
id
String ID of a backoffice user
is_accepted_toc
Boolean Flag whether a user had accepted T&C
is_active
language (optional)
lastLogin (optional)
Date Last login of backoffice user format: date-time
last_name
String Lastname of backoffice user
membership (optional)
oauths (optional)
permissions (optional)
referrer (optional)
role (optional)
timezone (optional)
updated_at (optional)
Date Date of update format: date-time
username
String Username of backoffice user format: email
A backoffice account (link view)
id
String ID of a backoffice user
A backoffice account (reference view)
email
String Email of backoffice user format: email
first_name
String Firstname of backoffice user
id
String ID of a backoffice user
last_name
String Lastname of backoffice user
username
String Username of backoffice user format: email
A backoffice user API key (default view)
created_at
Date Date of creation format: date-time
id
key
name
updated_at (optional)
Date Date of update format: date-time
bo_user collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
A backoffice user registration (default view)
confirmed_at (optional)
created_at
email
String Email of backoffice user format: email
first_name
String Firstname of backoffice user
id
String ID of a backoffice invite
language (optional)
last_name
String Lastname of backoffice user
organisation (optional)
role
updated_at (optional)
user (optional)
welcome_notification (optional)
bo_user_invite collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
A backoffice oauth user registration (default view)
email
first_name
is_accepted_dpa
is_accepted_toc
language (optional)
last_name
A backoffice user push subscription (default view)
created_at
Date Date of creation format: date-time
expo_token (optional)
id
notification_enabled (optional)
organisation (optional)
public_key
sound_notification_enabled (optional)
type (optional)
web
expo
updated_at (optional)
Date Date of update format: date-time
user_agent (optional)
bo_user_push_subscription collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
A backoffice user registration (default view)
confirmed_at (optional)
created_at
email
String Email of backoffice user format: email
first_name
String Firstname of backoffice user
id
String ID of a backoffice registration
is_accepted_dpa
Boolean Flag whether a user had accepted DPA
is_accepted_toc
Boolean Flag whether a user had accepted T&C
last_name
String Lastname of backoffice user
updated_at (optional)
Bo_user_registrationCollection is the media type for an array of Bo_user_registration (default view)
A backoffice account username change request (default view)
id
username
String Username of backoffice user format: email
bo_userapi_key_reference collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Bot (default view)
autostart_count (optional)
Integer Autostart after given page visits
autostart_timeout (optional)
Integer Autostart after given milliseconds
autostart_timeout_mobile (optional)
Long Autostart on mobile after given milliseconds format: int64
behaviours (optional)
channels (optional)
created_at
Date Date of creation format: date-time
default_variables (optional)
description (optional)
developer_mode (optional)
disable_auto_move (optional)
Boolean Disable an automatic move of the bot between the organizations
disable_redo (optional)
domain (optional)
edit_mode (optional)
edit_position (optional)
expiry_timeout (optional)
Integer Expire conversation after given hours
feedback_mode (optional)
enabled_all
enabled_responses
enabled_texts
disabled
frontend (optional)
ga (optional)
ga_events (optional)
ga_include_events (optional)
gtm_events (optional)
gtm_include_events (optional)
has_recaptcha (optional)
id
init_options (optional)
invalid_responses (optional)
landing_page (optional)
languages
live_chat (optional)
max_autostart_count (optional)
Integer Maximum number of autostarts for a given visitor
menu (optional)
message_delay (optional)
missing_responses (optional)
name
no_store_responses (optional)
no_view_responses (optional)
Boolean Disable viewing individual bot responses
not_found_responses (optional)
notification (optional)
open_on_exit_intent (optional)
open_on_exit_intent_mobile (optional)
open_on_exit_intent_timeout (optional)
Integer Open on exit intent after given milliseconds
open_on_exit_intent_timeout_mobile (optional)
Long Open on exit intent on mobile after given milliseconds format: int64
open_on_start (optional)
open_on_start_mobile (optional)
organisation (optional)
preload (optional)
prevent_exit_if_incomplete (optional)
Boolean Prevent user exit when bot is not complete
preview_image (optional)
preview_url (optional)
privacy_terms
redo_warning_text (optional)
remove_history_on_redo (optional)
reporting_token (optional)
String Auth token for reporting
response_actions (optional)
restart_after_close (optional)
restart_after_close_mobile (optional)
restore_state (optional)
Boolean Restore state of the bot after user drop
slug (optional)
sound_notifications (optional)
status
steps (optional)
template_group (optional)
theme (optional)
trigger_condition (optional)
type
updated_at (optional)
Date Date of update format: date-time
use_dynamic_translation (optional)
Boolean Use dynamic translation for the bot content
utm_campaign (optional)
utm_content (optional)
utm_custom (optional)
utm_medium (optional)
utm_source (optional)
utm_term (optional)
variables (optional)
Bot batch update collection payload
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Bot behaviour
autostart_count (optional)
Integer Autostart after given page visits
autostart_timeout (optional)
Integer Autostart after given milliseconds
autostart_timeout_mobile (optional)
Integer Autostart on mobile after given milliseconds
condition
description (optional)
String Description for backoffice reference
entry_point (optional)
Long Entry point step format: int64
id
key
max_autostart_count (optional)
Integer Maximum autostart count for a given visitor
name (optional)
String Name for backoffice reference
open_on_exit_intent (optional)
open_on_exit_intent_mobile (optional)
Boolean Open on exit intent on mobile
open_on_exit_intent_timeout (optional)
Integer Open on exit intent after given milliseconds
open_on_exit_intent_timeout_mobile (optional)
Integer Open on exit intent after given milliseconds on mobile
open_on_start (optional)
open_on_start_mobile (optional)
restart_after_close (optional)
restart_after_close_mobile (optional)
Boolean Restart after close on mobile
sound_notifications (optional)
theme (optional)
type
pre_init
post_init
Bot behaviour payload
autostart_count (optional)
Integer Autostart after given page visits
autostart_timeout (optional)
Integer Autostart after given milliseconds
autostart_timeout_mobile (optional)
Integer Autostart on mobile after given milliseconds
condition
condition_field (optional)
description (optional)
String Description for backoffice reference
entry_point (optional)
Long Entry point step format: int64
id (optional)
key
max_autostart_count (optional)
Integer Maximum autostart count for a given visitor
name (optional)
String Name for backoffice reference
open_on_exit_intent (optional)
open_on_exit_intent_mobile (optional)
Boolean Open on exit intent on mobile
open_on_exit_intent_timeout (optional)
Integer Open on exit intent after given milliseconds
open_on_exit_intent_timeout_mobile (optional)
Integer Open on exit intent after given milliseconds on mobile
open_on_start (optional)
open_on_start_mobile (optional)
post_init_condition_field (optional)
restart_after_close (optional)
restart_after_close_mobile (optional)
Boolean Restart after close on mobile
sound_notifications (optional)
theme (optional)
type
pre_init
post_init
Bot channel audio transcription settings
integration (optional)
is_enabled (optional)
Bot channel collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Bot channel config facebook page
BotChannelConfigGoogleBusinessMessages
Bot channel config instagram account
BotChannelConfigInstagram
Bot channel config instagram account
fb_page_id
fb_page_name
id
name
username
Bot channel message bird type
description (optional)
id
0
name (optional)
value
whatsapp
audio_transcription (optional)
dialog360_api_key (optional)
dialog360_base_path (optional)
dialog360_sandbox_api_key (optional)
dialog360_sandbox_base_path (optional)
dialog360_sandbox_user_id (optional)
dialog360_user_id (optional)
fb_autostart (optional)
fb_get_started_text (optional)
fb_handover_message (optional)
fb_page_id (optional)
google_business_messages_account_id (optional)
google_business_messages_location_id (optional)
instagram_account_id (optional)
line_bot_basic_id (optional)
line_channel_access_token (optional)
line_channel_id (optional)
line_channel_secret (optional)
menu (optional)
message_bird_api_key (optional)
message_bird_channel_id (optional)
message_bird_signing_key (optional)
message_bird_type (optional)
whatsapp
message_bird_user_id (optional)
name
telegram_access_token (optional)
telegram_username (optional)
text_to_speech (optional)
triggers (optional)
twilio_whatsapp_account_sid (optional)
twilio_whatsapp_auth_token (optional)
twilio_whatsapp_sandbox_account_sid (optional)
twilio_whatsapp_sandbox_auth_token (optional)
twilio_whatsapp_sandbox_user_id (optional)
twilio_whatsapp_user_id (optional)
type
facebook
web
twilio_whatsapp
line
message_bird
telegram
email
viber
dialog360
instagram
twitter
google_business_messages
viber_auth_token (optional)
viber_uri (optional)
Bot channel status
description (optional)
id
0
1
2
name (optional)
value
created
active
verified
Bot channel test URL
type
unspecified
android_web
android_google_maps
ios_google_maps
url
Bot channel text to speech settings
gender
male
female
integration (optional)
is_enabled (optional)
BotChannelTriggerBase
fb_comment_exclude_keywords (optional)
fb_comment_exclude_posts (optional)
fb_comment_include_keywords (optional)
fb_comment_include_posts (optional)
fb_comment_like (optional)
fb_comment_message (optional)
fb_comment_reply (optional)
id (optional)
key
Bot channel type
description (optional)
id
0
1
2
3
4
5
6
7
8
9
10
11
name (optional)
value
facebook
web
twilio_whatsapp
line
message_bird
telegram
email
viber
dialog360
instagram
twitter
google_business_messages
Bot chat step answer payload
Bot chat step option collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Bot chat step text feedback payload
feedback (optional)
rating
text (optional)
Bot chat text
autoplay (optional)
avatar (optional)
Integer Key of the avatar image to switch bot to
controls (optional)
delay (optional)
disable_feedback (optional)
id
key
landing_page_background (optional)
Integer Key of the landing page background image to switch to
loop (optional)
muted (optional)
script (optional)
src (optional)
step (optional)
stream_variable (optional)
target (optional)
text
type
url (optional)
Bot chat text payload
autoplay (optional)
avatar (optional)
Integer Key of the avatar image to switch bot to
controls (optional)
delay (optional)
disable_feedback (optional)
id (optional)
key
landing_page_background (optional)
Integer Key of the landing page background image to switch to
loop (optional)
muted (optional)
script (optional)
src (optional)
stream_variable (optional)
target (optional)
_self
_blank
_parent
_top
text
type
text
link
html
info
landing_page_background
avatar
script
image
video
pixel
embed
file
audio_file
video_file
variable_stream
url (optional)
Bot chat text type
description (optional)
id
0
2
1
3
4
8
5
6
7
9
10
11
12
13
14
name (optional)
value
text
link
html
info
landing_page_background
avatar
script
image
video
pixel
embed
file
audio_file
video_file
variable_stream
Bot collection payload
contact (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
status (optional)
active
inactive
Bot create payload
autostart_count (optional)
Integer Autostart after given page visits
autostart_timeout (optional)
Integer Autostart after given milliseconds
autostart_timeout_mobile (optional)
Long Autostart on mobile after given milliseconds format: int64
behaviours (optional)
description (optional)
developer_mode (optional)
disable_auto_move (optional)
Boolean Disable an automatic move of the bot between the organizations
disable_redo (optional)
domain (optional)
edit_mode (optional)
list
diagram
edit_position (optional)
expiry_timeout (optional)
Integer Expire conversation after given hours
feedback_mode (optional)
enabled_all
enabled_responses
enabled_texts
disabled
ga (optional)
ga_events (optional)
ga_include_events (optional)
gtm_events (optional)
gtm_include_events (optional)
has_recaptcha (optional)
id (optional)
ignore_sound_notifications (optional)
init_options (optional)
invalid_responses (optional)
landing_page (optional)
languages (optional)
live_chat (optional)
max_autostart_count (optional)
Integer Maximum number of autostarts for a given visitor
menu (optional)
message_delay (optional)
missing_responses (optional)
name
no_store_responses (optional)
no_view_responses (optional)
Boolean Disable viewing individual bot responses
not_found_responses (optional)
notification (optional)
open_on_exit_intent (optional)
open_on_exit_intent_mobile (optional)
open_on_exit_intent_timeout (optional)
Integer Open on exit intent after given milliseconds
open_on_exit_intent_timeout_mobile (optional)
Long Open on exit intent on mobile after given milliseconds format: int64
open_on_start (optional)
open_on_start_mobile (optional)
preload (optional)
prevent_exit_if_incomplete (optional)
Boolean Prevent user exit when bot is not complete
preview_image (optional)
preview_url (optional)
privacy_terms
redo_warning_text (optional)
remove_history_on_redo (optional)
response_actions (optional)
restart_after_close (optional)
restart_after_close_mobile (optional)
restore_state (optional)
Boolean Restore state of the bot after user drop
slug (optional)
sound_notifications (optional)
steps
template_group (optional)
theme (optional)
trigger_condition (optional)
trigger_condition_field (optional)
trigger_condition_operator (optional)
type
form
survey
use_dynamic_translation (optional)
Boolean Use dynamic translation for the bot content
utm_campaign (optional)
utm_content (optional)
utm_custom (optional)
utm_medium (optional)
utm_source (optional)
utm_term (optional)
variables (optional)
Bot drop off report payload
begin (optional)
Date Begin date and time format: date-time
end (optional)
Date End date and time format: date-time
Bot edit mode
description (optional)
id
0
1
name (optional)
value
list
diagram
Bot feedback report item
count
created_at (optional)
feedback (optional)
rating
rendered_text (optional)
response (optional)
step (optional)
text (optional)
Bot feedback report payload
begin (optional)
Date Begin date and time format: date-time
end (optional)
Date End date and time format: date-time
rating
neutral
negative
positive
overall
Bot frontend
custom_landing_page_url (optional)
String Custom landing page url
custom_landing_page_url_amp (optional)
String Custom landing page url (AMP)
embed_code (optional)
String Embed code (deprecated)
embed_code_2 (optional)
embed_code_2_no_integrity (optional)
String Embed code without integrity
embed_code_amp (optional)
embed_snippet (optional)
String Embed snippet (deprecated)
embed_snippet_2 (optional)
embed_url (optional)
String Embed url (for the use in the iframes and web views)
external_preview_url (optional)
String External preview url (deprecated)
external_preview_url_2 (optional)
String External preview url (new)
id (optional)
landing_page_url (optional)
landing_page_url_amp (optional)
media_url (optional)
path (optional)
preview_url (optional)
preview_url_amp (optional)
static_url (optional)
Bot frontend AMP
body (optional)
head (optional)
completion
Double Completion format: double
drops
id
name
responses
type
visits
Bot funnel report payload
begin (optional)
Date Begin date and time format: date-time
end (optional)
Date End date and time format: date-time
id
is_filtered
key
number
percentage
text
total
Bot interactive report payload
begin (optional)
Date Begin date and time format: date-time
end (optional)
Date End date and time format: date-time
items
key
Long User-provided key format: int64
options
Bot interactive report step
average
drops
id
is_filtered
key
Long User-provided key format: int64
name
number
options
percentage
total
type
Bot landing page
background_color (optional)
backgrounds (optional)
css (optional)
description (optional)
favicon (optional)
footer_html (optional)
message_description (optional)
message_description_color (optional)
String Message description color
message_subtitle (optional)
message_subtitle_color (optional)
message_title (optional)
message_title_color (optional)
start_button_background_color (optional)
String Start button background color
start_button_text_color (optional)
String Start button text color
start_button_title (optional)
text_shadow (optional)
title (optional)
Bot landing page background
id (optional)
image
is_default (optional)
key
name
video (optional)
video_dimensions (optional)
video_muted (optional)
Bot live chat settings
button_text (optional)
button_tooltip (optional)
chat_agent_joined_message (optional)
chat_agent_left_message (optional)
chat_channel_email_message (optional)
chat_closed_email_message (optional)
chat_closed_message (optional)
chat_created_email_message (optional)
chat_created_message (optional)
chat_handed_over_to_bot_message (optional)
chat_merged_from_email_message (optional)
chat_merged_from_message (optional)
chat_merged_to_email_message (optional)
chat_merged_to_message (optional)
chat_message_variables (optional)
chat_offline_timeout (optional)
Integer Chat offline timeout in minutes
chat_reopened_email_message (optional)
chat_reopened_message (optional)
create_on_response (optional)
Boolean Create chat on bot response
create_on_response_condition (optional)
Object Create chat on bot response condition
default_description (optional)
default_subject (optional)
disable_agent_attachments (optional)
disable_contact_attachments (optional)
Boolean Disable contact attachments
script (optional)
show_button (optional)
show_description (optional)
show_subject (optional)
type
user_avatar (optional)
String Fallback avatar for the user
Bot live chat settings payload
button_text (optional)
button_tooltip (optional)
chat_agent_joined_message (optional)
chat_agent_left_message (optional)
chat_channel_email_message (optional)
chat_closed_email_message (optional)
chat_closed_message (optional)
chat_created_email_message (optional)
chat_created_message (optional)
chat_handed_over_to_bot_message (optional)
chat_merged_from_email_message (optional)
chat_merged_from_message (optional)
chat_merged_to_email_message (optional)
chat_merged_to_message (optional)
chat_offline_timeout (optional)
Integer Chat offline timeout in minutes
chat_reopened_email_message (optional)
chat_reopened_message (optional)
create_on_response (optional)
Boolean Create chat on bot response
create_on_response_condition (optional)
Object Create chat on bot response condition
default_description (optional)
default_subject (optional)
disable_agent_attachments (optional)
disable_contact_attachments (optional)
Boolean Disable contact attachments
script (optional)
show_button (optional)
show_description (optional)
show_subject (optional)
type
native
custom
user_avatar (optional)
String Fallback avatar for the user
Bot live chat type
description (optional)
id
0
1
name (optional)
value
native
custom
Bot location report item
completion
Double Completion format: double
drops
id
lat
Double Latitude format: double
lon
Double Longitude format: double
name
responses
visits
Bot location report payload
begin (optional)
Date Begin date and time format: date-time
continent (optional)
country (optional)
end (optional)
Date End date and time format: date-time
Bot monitoring channel item
id
inits
name
starts
stops
type
updates
Bot monitoring device item
id
inits
starts
stops
type
updates
Bot monitoring hostname item
id
inits
name
starts
stops
updates
number
Long Absolute value format: int64
percentage
Double Percentage format: double
Bot monitoring overall item
inits
starts
stops
updates
Bot monitoring report item
channels
datetime
Date Datetime format: date-time
devices
hostnames
overall
Bot monitoring report payload
begin (optional)
Date Begin date and time format: date-time
end (optional)
Date End date and time format: date-time
resolution
String Report data point time resolution
5m
1h
1d
1w
1M
Bot next target
description (optional)
id
0
1
2000
2001
2002
name (optional)
value
exit
redirect
restart
live_chat
handover
Bot notification
daily (optional)
daily_subject (optional)
email (optional)
email_from (optional)
id (optional)
monthly (optional)
monthly_subject (optional)
steps (optional)
array[Long] Steps to include in the stats format: int64
weekly (optional)
weekly_subject (optional)
Bot notification payload
daily (optional)
daily_subject (optional)
email (optional)
email_from (optional)
id (optional)
monthly (optional)
monthly_subject (optional)
steps (optional)
array[Long] Steps to include in the stats format: int64
weekly (optional)
weekly_subject (optional)
bottom (optional)
top (optional)
bottom (optional)
top (optional)
Bot persistent menu
image (optional)
String Background image for the menu
items
Bot persistent menu item
description (optional)
id (optional)
key
subscribe_group (optional)
subscribe_message (optional)
title (optional)
type
url
handover
start
finish
live_chat
restart
subscribe
unsubscribe
unsubscribe_group (optional)
unsubscribe_message (optional)
url (optional)
Bot position
description (optional)
id
0
1
2
3
name (optional)
value
right
left
center
full_width
Bot (preview view)
frontend (optional)
slug (optional)
Bot progress report item
channels
datetime
Date Datetime format: date-time
devices
exits
overall
steps (optional)
Bot progress report payload
begin (optional)
Date Begin date and time format: date-time
end (optional)
Date End date and time format: date-time
resolution
String Report data point time resolution
5m
1h
1d
1w
1M
Bot (reference view)
id
name
organisation (optional)
slug (optional)
Bot reference type (workaround)
id
name
organisation (optional)
slug (optional)
Bot (reporting view)
reporting_token (optional)
String Auth token for reporting
reporting_url (optional)
Bot reporting token payload
Bot response action
basic_auth (optional)
condition (optional)
description (optional)
String Description for backoffice reference
email_bcc (optional)
email_cc (optional)
email_from (optional)
email_reply_to (optional)
String Email reply to addresses
email_subject (optional)
email_template_type (optional)
email_to (optional)
form_body_values (optional)
form_content_type (optional)
google_drive_spreadsheet_document (optional)
google_drive_spreadsheet_integration (optional)
google_drive_spreadsheet_list (optional)
headers (optional)
id
is_enabled (optional)
json_body (optional)
key
mailchimp_api_key (optional)
mailchimp_list_id (optional)
name (optional)
String Name for backoffice reference
slack_channel_name (optional)
subscribe_group (optional)
text (optional)
type (optional)
unsubscribe_group (optional)
url (optional)
Bot response action email template type
description (optional)
id
0
1
2
name (optional)
value
organisation
respondent
custom
Bot response action header
id
key
name
value (optional)
Bot response action header payload
id (optional)
key
name
value (optional)
Bot response actions log item collection payload
begin (optional)
end (optional)
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Bot response action log item reference type (workaround)
action (optional)
created_at
id
is_error
Bot response action payload
basic_auth (optional)
condition (optional)
description (optional)
String Description for backoffice reference
email_bcc (optional)
email_cc (optional)
email_from (optional)
email_reply_to (optional)
String Email reply to addresses
email_subject (optional)
email_template_type (optional)
organisation
respondent
custom
email_to (optional)
form_body_values (optional)
form_content_type (optional)
form
form_url_encoded
google_drive_spreadsheet_document (optional)
google_drive_spreadsheet_integration (optional)
google_drive_spreadsheet_list (optional)
headers (optional)
id (optional)
is_enabled (optional)
json_body (optional)
key
mailchimp_api_key (optional)
mailchimp_list_id (optional)
name (optional)
String Name for backoffice reference
slack_channel_name (optional)
subscribe_group (optional)
text (optional)
type
form
json
slack
email
mailchimp
hugo
zapier
integromat
freshdesk
freshsales
freshworks_crm
mailchimp_api
google_drive_spreadsheet
subscribe
unsubscribe
unsubscribe_group (optional)
url (optional)
Bot response action type
description (optional)
id
0
1
2
3
4
5
6
7
8
9
11
10
12
13
14
name (optional)
value
form
json
slack
email
mailchimp
hugo
zapier
integromat
freshdesk
freshsales
freshworks_crm
mailchimp_api
google_drive_spreadsheet
subscribe
unsubscribe
Bot response collection payload
begin (optional)
bot (optional)
channel (optional)
contact (optional)
end (optional)
ids (optional)
is_complete (optional)
is_preview (optional)
is_spam (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Bot response delete payload
begin (optional)
bot (optional)
channel (optional)
contact (optional)
end (optional)
ids (optional)
is_complete (optional)
is_preview (optional)
is_spam (optional)
search (optional)
Bot start payload
mode (optional)
recaptcha_response (optional)
visit_count (optional)
Bot stats channel item
completion
Double Completion format: double
drops
id
name
responses
type
visits
Bot stats device item
completion
Double Completion format: double
drops
id
responses
type
visits
Bot stats exit item
completion
Double Completion format: double
drops
id
name
responses
type
visits
number
Long Absolute value format: int64
percentage
Double Percentage format: double
time
Double Time in seconds format: double
Bot stats overall item
completion
Double Completion format: double
drops
responses
visits
Bot stats report payload
begin (optional)
Date Begin date and time format: date-time
end (optional)
Date End date and time format: date-time
Bot stats step item
completion
Double Completion format: double
drops
id
name
responses
type
visits
Bot status
description (optional)
id
0
1
name (optional)
value
active
inactive
Bot step
choices (optional)
Long Number of choices format: int64
code_name
String User-provided code name
color (optional)
default (optional)
default_next (optional)
Long Default next step format: int64
display_type (optional)
edit_position (optional)
exit_edit_position (optional)
file_accepted (optional)
file_allow_camera (optional)
file_url_is_direct (optional)
file_url_is_public (optional)
file_url_timeout (optional)
Long File URL timeout (when direct), seconds format: int64
get_options_script (optional)
get_settings_script (optional)
go_button_text (optional)
has_other (optional)
Boolean Does the step has other option
help_text (optional)
html (optional)
id
idle_next (optional)
infinite_scroll (optional)
Boolean Infinite scroll for the select options
invalid_responses (optional)
is_date_time (optional)
is_hidden (optional)
Boolean Is hidden from the transcript
is_range (optional)
Boolean Is step a range or single input
is_required (optional)
is_self_learning (optional)
is_title_link_disabled (optional)
key
Long User-provided key format: int64
knowledge_base (optional)
knowledge_base_sections (optional)
left_label (optional)
location_cities (optional)
location_countries (optional)
location_skip_geocode (optional)
location_type (optional)
max (optional)
max_date (optional)
Date Max date format: date-time
max_label (optional)
max_length (optional)
Long Max length format: int64
max_time (optional)
min (optional)
min_date (optional)
Date Min date format: date-time
min_label (optional)
min_length (optional)
Long Min length format: int64
min_option_width (optional)
Long Min option width format: int64
min_time (optional)
missing_responses (optional)
more_button_text (optional)
name (optional)
not_found_responses (optional)
options (optional)
options_layout (optional)
placeholder (optional)
prefix (optional)
randomize_options (optional)
rating_type (optional)
regexp (optional)
responses (optional)
right_label (optional)
search_threshold (optional)
BigDecimal Search threshold. At what point does the match algorithm give up. A threshold of 0.0 requires a perfect match (of both letters and location), a threshold of 1.0 would match anything.
show_decimals (optional)
show_privacy (optional)
show_terms (optional)
show_thousand_separator (optional)
skip_fold_out_wait (optional)
Boolean Skip waiting for the step popup window
slider_step_size (optional)
submit_by_enter (optional)
texts
title (optional)
type
units (optional)
url (optional)
validate_script (optional)
Bot step display
description (optional)
id
0
1
2
name (optional)
value
iframe
html
window
Bot step location type
description (optional)
id
0
1
3
2
4
5
6
7
8
name (optional)
value
city
establishment
region
geocode
country
state
geocode_establishment
postal_code
street_address
Bot step option
button_text (optional)
icon (optional)
id (optional)
image (optional)
is_custom (optional)
is_fixed (optional)
key
sub_text (optional)
text (optional)
url (optional)
url_target (optional)
Bot step option payload
button_text (optional)
icon (optional)
id (optional)
image (optional)
is_custom (optional)
is_fixed (optional)
key
sub_text (optional)
text (optional)
url (optional)
url_target (optional)
_self
_blank
_parent
_top
Bot step select options layout
description (optional)
id
0
1
name (optional)
value
list
grid
Bot step payload
choices (optional)
Long Number of choices format: int64
code_name
String User-provided code name
color (optional)
default (optional)
default_next (optional)
Long Default next step format: int64
display_type (optional)
iframe
html
window
edit_position (optional)
exit_edit_position (optional)
file_accepted (optional)
file_allow_camera (optional)
file_url_is_direct (optional)
file_url_is_public (optional)
file_url_timeout (optional)
Long File URL timeout (when direct), seconds format: int64
get_options_script (optional)
get_settings_script (optional)
go_button_text (optional)
has_other (optional)
Boolean Does the step has other option
help_text (optional)
html (optional)
id (optional)
idle_next (optional)
infinite_scroll (optional)
Boolean Infinite scroll for the select options
is_date_time (optional)
is_hidden (optional)
Boolean Is hidden from the transcript
is_range (optional)
Boolean Is step a range or single input
is_required (optional)
is_self_learning (optional)
is_title_link_disabled (optional)
key
knowledge_base (optional)
knowledge_base_sections (optional)
left_label (optional)
location_cities (optional)
location_countries (optional)
location_skip_geocode (optional)
location_type (optional)
city
establishment
region
geocode
country
state
geocode_establishment
postal_code
street_address
max (optional)
max_date (optional)
Date Max date format: date-time
max_label (optional)
max_length (optional)
Long Max length format: int64
max_time (optional)
min (optional)
min_date (optional)
Date Min date format: date-time
min_label (optional)
min_length (optional)
Long Min length format: int64
min_option_width (optional)
Long Min option width format: int64
min_time (optional)
more_button_text (optional)
name
options (optional)
options_layout (optional)
list
grid
placeholder (optional)
prefix (optional)
randomize_options (optional)
rating_type (optional)
dots
stars
regexp (optional)
responses (optional)
right_label (optional)
search_threshold (optional)
BigDecimal Search threshold. At what point does the match algorithm give up. A threshold of 0.0 requires a perfect match (of both letters and location), a threshold of 1.0 would match anything.
show_decimals (optional)
show_privacy (optional)
show_terms (optional)
show_thousand_separator (optional)
skip_fold_out_wait (optional)
Boolean Skip waiting for the step popup window
slider_step_size (optional)
submit_by_enter (optional)
texts
title (optional)
type
short_text
long_text
multiple_choice
autocomplete
yes_no
yes_no_display
legal
email
number
rating
phone
name
first_name
last_name
iban
location
datetime
time
datetime_range
birthdate
slider
multiple_image
image_autocomplete
start
button
end
message
return
external_chat
file
password
language_switch
knowledge_base_search
custom
units (optional)
url (optional)
validate_script (optional)
Bot step rating type
description (optional)
id
0
1
name (optional)
value
dots
stars
Bot step response
condition (optional)
edit_position (optional)
id
is_default (optional)
key
landing_page_background (optional)
String Landing page background
next (optional)
next_at (optional)
String Next step datetime (variable or value)
next_delay (optional)
String Next step delay (variable or value)
next_target (optional)
next_url (optional)
next_url_follow (optional)
Integer Follow the next url instead of existing before the redirect
next_url_target (optional)
one_time_notification_at (optional)
String One time notification datetime (variable or value)
one_time_notification_confirm_text (optional)
one_time_notification_delay (optional)
String One time notification delay (variable or value)
one_time_notification_request_title (optional)
one_time_notification_text (optional)
option (optional)
Long Option format: int64
save_chat (optional)
send_one_time_notification (optional)
texts
type (optional)
Bot step response payload
condition (optional)
edit_position (optional)
id (optional)
is_default (optional)
key
landing_page_background (optional)
String Landing page background
next (optional)
next_at (optional)
String Next step datetime (variable or value)
next_delay (optional)
String Next step delay (variable or value)
next_url (optional)
next_url_follow (optional)
Integer Follow the next url instead of existing before the redirect
next_url_target (optional)
_self
_blank
_parent
_top
one_time_notification_at (optional)
String One time notification datetime (variable or value)
one_time_notification_confirm_text (optional)
one_time_notification_delay (optional)
String One time notification delay (variable or value)
one_time_notification_request_title (optional)
one_time_notification_text (optional)
option (optional)
Long Option format: int64
save_chat (optional)
send_one_time_notification (optional)
texts
type (optional)
default
invalid
missing
not_found
Bot step response type
description (optional)
id
0
1
2
3
name (optional)
value
default
invalid
missing
not_found
Bot step type
description (optional)
id
1
0
4
23
2
22
222
9
11
10
12
46
47
48
13
15
8
52
18
19
303
3
51
101
43
42
100
102
7
45
49
50
53
54
name (optional)
value
short_text
long_text
multiple_choice
autocomplete
yes_no
yes_no_display
legal
email
number
rating
phone
name
first_name
last_name
iban
location
datetime
time
datetime_range
birthdate
slider
multiple_image
image_autocomplete
start
button
end
message
return
external_chat
file
password
language_switch
knowledge_base_search
custom
Bot template collection payload
group (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Bot template group
description
id
index
name
Bot theme
active_color (optional)
attention_avatar (optional)
attention_color (optional)
avatar_background (optional)
avatar_position (optional)
avatar_size (optional)
avatars (optional)
body (optional)
bot_offset (optional)
bot_position (optional)
bot_position_rtl (optional)
bot_view_mode (optional)
css (optional)
error_color (optional)
error_message_color (optional)
image_color (optional)
inverse_text_color (optional)
message_background (optional)
redo_color (optional)
show_close (optional)
show_footer (optional)
show_scroll (optional)
show_settings (optional)
show_sticky_avatar (optional)
show_sticky_avatar_mobile (optional)
Boolean Show sticky avatar on mobile
sticky_avatar (optional)
sticky_avatar_animation (optional)
sticky_avatar_background (optional)
String Sticky avatar background color
sticky_avatar_offset (optional)
sticky_avatar_popup (optional)
sticky_avatar_shadow (optional)
text_color (optional)
theme_color (optional)
white_label (optional)
Bot theme avatar
first_name (optional)
id (optional)
image
is_default (optional)
key
last_name (optional)
name
Bot theme behaviour
bot_offset (optional)
bot_position (optional)
bot_position_rtl (optional)
bot_view_mode (optional)
show_sticky_avatar (optional)
show_sticky_avatar_mobile (optional)
Boolean Show sticky avatar on mobile
sticky_avatar (optional)
sticky_avatar_animation (optional)
sticky_avatar_background (optional)
String Sticky avatar background color
sticky_avatar_offset (optional)
sticky_avatar_popup (optional)
sticky_avatar_shadow (optional)
Bot theme behaviour payload
bot_offset (optional)
bot_position (optional)
right
left
center
full_width
bot_position_rtl (optional)
right
left
center
full_width
bot_view_mode (optional)
unboxed
boxed
show_sticky_avatar (optional)
show_sticky_avatar_mobile (optional)
Boolean Show sticky avatar on mobile
sticky_avatar (optional)
sticky_avatar_animation (optional)
sticky_avatar_background (optional)
String Sticky avatar background color
sticky_avatar_offset (optional)
sticky_avatar_popup (optional)
sticky_avatar_shadow (optional)
Bot theme payload
active_color (optional)
attention_avatar (optional)
attention_color (optional)
avatar_background (optional)
avatar_position (optional)
avatar_size (optional)
avatars (optional)
body (optional)
bot_offset (optional)
bot_position (optional)
right
left
center
full_width
bot_position_rtl (optional)
right
left
center
full_width
bot_view_mode (optional)
unboxed
boxed
css (optional)
error_color (optional)
error_message_color (optional)
image_color (optional)
inverse_text_color (optional)
message_background (optional)
redo_color (optional)
show_close (optional)
show_footer (optional)
show_scroll (optional)
show_settings (optional)
show_sticky_avatar (optional)
show_sticky_avatar_mobile (optional)
Boolean Show sticky avatar on mobile
sticky_avatar (optional)
sticky_avatar_animation (optional)
sticky_avatar_background (optional)
String Sticky avatar background color
sticky_avatar_offset (optional)
sticky_avatar_popup (optional)
sticky_avatar_shadow (optional)
text_color (optional)
theme_color (optional)
white_label (optional)
Bot transfer payload
name
organisation
slug (optional)
Bot type
description (optional)
id
0
1
name (optional)
value
form
survey
Bot update payload
autostart_count (optional)
Integer Autostart after given page visits
autostart_timeout (optional)
Integer Autostart after given milliseconds
autostart_timeout_mobile (optional)
Long Autostart on mobile after given milliseconds format: int64
behaviours (optional)
description (optional)
developer_mode (optional)
disable_auto_move (optional)
Boolean Disable an automatic move of the bot between the organizations
disable_redo (optional)
domain (optional)
edit_mode (optional)
list
diagram
edit_position (optional)
expiry_timeout (optional)
Integer Expire conversation after given hours
feedback_mode (optional)
enabled_all
enabled_responses
enabled_texts
disabled
ga (optional)
ga_events (optional)
ga_include_events (optional)
gtm_events (optional)
gtm_include_events (optional)
has_recaptcha (optional)
init_options (optional)
invalid_responses (optional)
landing_page (optional)
languages (optional)
live_chat (optional)
max_autostart_count (optional)
Integer Maximum number of autostarts for a given visitor
menu (optional)
message_delay (optional)
missing_responses (optional)
name (optional)
no_store_responses (optional)
no_view_responses (optional)
Boolean Disable viewing individual bot responses
not_found_responses (optional)
notification (optional)
open_on_exit_intent (optional)
open_on_exit_intent_mobile (optional)
open_on_exit_intent_timeout (optional)
Integer Open on exit intent after given milliseconds
open_on_exit_intent_timeout_mobile (optional)
Long Open on exit intent on mobile after given milliseconds format: int64
open_on_start (optional)
open_on_start_mobile (optional)
preload (optional)
prevent_exit_if_incomplete (optional)
Boolean Prevent user exit when bot is not complete
privacy_terms (optional)
redo_warning_text (optional)
remove_history_on_redo (optional)
response_actions (optional)
restart_after_close (optional)
restart_after_close_mobile (optional)
restore_state (optional)
Boolean Restore state of the bot after user drop
slug (optional)
sound_notifications (optional)
status (optional)
active
inactive
steps (optional)
theme (optional)
trigger_condition (optional)
type (optional)
form
survey
updated_at (optional)
Date Date of update format: date-time
use_dynamic_translation (optional)
Boolean Use dynamic translation for the bot content
utm_campaign (optional)
utm_content (optional)
utm_custom (optional)
utm_medium (optional)
utm_source (optional)
utm_term (optional)
variables (optional)
Bot variable
chat_completion (optional)
description (optional)
fallback (optional)
id
integration (optional)
integration_type (optional)
freshdesk
google_drive
open_ai
azure_cognitive_services_speech
is_default (optional)
Boolean Flag if variable is default
is_server (optional)
Boolean Flag is variable is resolved server-side
key
name
String Name for backoffice reference
skip_timestream (optional)
Boolean Flag if variable to be skipped in timestream
step (optional)
text_to_speech (optional)
type
value (optional)
Bot variable chat completion
assistant (optional)
followup_params (optional)
function_script (optional)
initial_params (optional)
Bot variable log item collection payload
begin (optional)
end (optional)
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Bot variable payload
chat_completion (optional)
description (optional)
fallback (optional)
id (optional)
integration (optional)
integration_type (optional)
freshdesk
google_drive
open_ai
azure_cognitive_services_speech
is_server (optional)
Boolean Flag is variable is resolved server-side
key
name
String Name for backoffice reference
step (optional)
text_to_speech (optional)
type
step
string
script
text_completion
image_generation
chat_completion
audio_transcription
audio_translation
text_to_speech
value (optional)
Bot variable text to speech
format (optional)
text
ssml
gender (optional)
male
female
speed (optional)
voice (optional)
alloy
echo
fable
onyx
nova
shimmer
Bot variable type
description (optional)
id
0
1
2
3
4
6
7
8
9
name (optional)
value
step
string
script
text_completion
image_generation
chat_completion
audio_transcription
audio_translation
text_to_speech
Bot view mode
description (optional)
id
0
1
name (optional)
value
unboxed
boxed
A bot batch update (default view)
completed (optional)
Long Number of completed items format: int64
created_at
Date Date of creation format: date-time
error (optional)
failed (optional)
Long Number of failed items format: int64
id
name
organisation (optional)
params (optional)
status
created
prepared
processing
completed
failed
total (optional)
Long Total number of items to process format: int64
updated_at (optional)
Date Date of update format: date-time
bot_batch_update collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
BotChannel (default view)
audio_transcription (optional)
auth_url (optional)
can_launch (optional)
can_unlaunch (optional)
created_at
dialog360_api_key (optional)
dialog360_base_path (optional)
dialog360_sandbox_api_key (optional)
dialog360_sandbox_base_path (optional)
dialog360_sandbox_user_id (optional)
dialog360_user_id (optional)
fb_autostart (optional)
fb_get_started_text (optional)
fb_handover_message (optional)
fb_page_id (optional)
fb_page_name (optional)
fb_subject_to_new_eu_privacy_rules (optional)
fb_user_id (optional)
fb_user_name (optional)
google_business_messages_account_id (optional)
google_business_messages_brand_name (optional)
google_business_messages_location_id (optional)
google_business_messages_location_name (optional)
handover_url (optional)
id
instagram_account_id (optional)
instagram_account_name (optional)
instagram_account_user_name (optional)
instagram_page_id (optional)
instagram_page_name (optional)
line_bot_basic_id (optional)
line_channel_access_token (optional)
line_channel_id (optional)
line_channel_secret (optional)
live_chat_url (optional)
menu (optional)
message_bird_api_key (optional)
message_bird_channel_id (optional)
message_bird_signing_key (optional)
message_bird_type (optional)
message_bird_user_id (optional)
name
status (optional)
status_webhook_url (optional)
telegram_access_token (optional)
telegram_username (optional)
test_urls (optional)
text_to_speech (optional)
triggers (optional)
twilio_whatsapp_account_sid (optional)
twilio_whatsapp_auth_token (optional)
twilio_whatsapp_sandbox_account_sid (optional)
twilio_whatsapp_sandbox_auth_token (optional)
twilio_whatsapp_sandbox_user_id (optional)
twilio_whatsapp_user_id (optional)
twitter_account_id (optional)
twitter_account_name (optional)
twitter_account_screen_name (optional)
type
updated_at (optional)
url (optional)
viber_auth_token (optional)
viber_uri (optional)
webhook_url (optional)
BotChannel (reference view)
bot_channel collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Bot channel config (default view)
channel (optional)
facebook (optional)
google_business_messages (optional)
instagram (optional)
Bot channel preview (default view)
Bot chat step (default view)
app_id
language
languages
response_id (optional)
step
Bot chat step option (default view)
button_text (optional)
icon (optional)
id (optional)
image (optional)
is_custom (optional)
is_fixed (optional)
key
sub_text (optional)
text (optional)
url (optional)
url_target (optional)
bot_chat_step_option collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Bot chat variable (default view)
id
is_default (optional)
Boolean Flag if variable is default
is_server (optional)
Boolean Flag is variable is resolved server-side
key
name
String Name for backoffice reference
step (optional)
type
value (optional)
bot collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
template_groups (optional)
Bot drop off report (default view)
devices (optional)
exits (optional)
steps (optional)
Bot feedback report (default view)
items
max
Long Max rating format: int64
min
Long Min rating format: int64
Bot funnel report (default view)
count
Long Total number of items format: int64
items
Bot interactive report (default view)
count
Long Total number of responses format: int64
items
Bot location report (default view)
count
Long Total number of responses format: int64
items
Bot monitoring report (default view)
count
Long Total number of responses format: int64
items
Bot progress over time report (default view)
count
Long Total number of items format: int64
items
Bot response (default view)
action_log_items (optional)
bot (optional)
channel (optional)
chats (optional)
contact (optional)
created_at
Date Date of creation format: date-time
id
is_preview (optional)
is_spam (optional)
table
variables (optional)
Bot response (reference view)
Bot response action log item (default view)
action (optional)
bot_response (optional)
created_at
id
is_error
request
response
bot_response_action_log_item collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
bot_response collection (default view)
columns
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Bot_response_upload media type (default view)
created_at
id
name
params
type
updated_at (optional)
url
Bot statistics (default view)
channels (optional)
devices
exits
id
overall
Bot variable log item (default view)
bot_response (optional)
created_at
id
is_error
request
response
variable (optional)
bot_variable_log_item collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Campaign (default view)
automation_rules (optional)
bounces (optional)
Long Bounces format: int64
complaints (optional)
Long Complaints format: int64
created_at
description (optional)
errors (optional)
Long Errors format: int64
id
languages
message (optional)
name
sent (optional)
sent_at (optional)
Date Sent at format: date-time
soft_bounces (optional)
Long Soft bounces format: int64
status
created
scheduled
processing
sent
to_send_at (optional)
Date To send at format: date-time
type
manual
automated
updated_at (optional)
Campaign automation rule
actions
condition (optional)
condition_field (optional)
condition_operator (optional)
created_at (optional)
Date Created format: date-time
description (optional)
String Description for backoffice reference
id (optional)
is_enabled (optional)
key
name (optional)
String Name for backoffice reference
stop_processing (optional)
trigger_type
organisation_periodic_timer_daily
organisation_periodic_timer_weekly
organisation_periodic_timer_monthly
updated_at (optional)
Date Updated format: date-time
Campaign automation rule action
created_at (optional)
Date Created format: date-time
id (optional)
key
rule (optional)
send_message (optional)
type
send_message
updated_at (optional)
Date Updated format: date-time
variables (optional)
Campaign automation rule action log item collection payload
action (optional)
begin (optional)
end (optional)
ids (optional)
page_number (optional)
page_size (optional)
rule (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Campaign automation rule action send message
message
start_chat (optional)
Campaign automation rule condition operator field
description (optional)
id
18
19
20
21
name (optional)
value
dayOfWeek
time
day
month
Campaign automation rule condition operator
description (optional)
id
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
18
17
19
name (optional)
value
=
!=
startsWith
notStartsWith
endsWith
notEndsWith
matchesRegEx
notMatchesRegEx
iMatchesRegEx
notIMatchesRegEx
<
>
<=
>=
in
notIn
contains
iContains
notContains
notIContains
Campaign automation rule reference
Campaign collection payload
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Campaign delete payload
ids (optional)
search (optional)
Campaign message
created_at (optional)
email_bcc (optional)
email_cc (optional)
email_from (optional)
email_reply_to (optional)
exclude_channel_types (optional)
groups
id (optional)
include_channel_types (optional)
subject (optional)
text (optional)
updated_at (optional)
Campaign payload
automation_rules (optional)
description (optional)
languages (optional)
message (optional)
name
type
manual
automated
Campaign send payload
to_send_at (optional)
Date Send date format: date-time
Campaign automation rule action log item (default view)
action (optional)
created_at
id
is_error
request
response
campaign_automation_rule_action_log_item collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
campaign collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Chat contact collection payload
begin (optional)
bot (optional)
end (optional)
ids (optional)
is_spam (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
status (optional)
Chat contact delete payload
begin (optional)
bot (optional)
end (optional)
ids (optional)
search (optional)
Chat contact payload
avatar (optional)
email (optional)
fb_id (optional)
first_name (optional)
gender (optional)
male
female
id (optional)
instagram_id (optional)
is_spam (optional)
last_name (optional)
line_id (optional)
phone (optional)
status (optional)
away
online
invisible
telegram_id (optional)
twitter_id (optional)
viber_id (optional)
visitor_id (optional)
Contact (default view)
avatar (optional)
bot (optional)
created_at
Date Date of creation format: date-time
email (optional)
fb_id (optional)
first_name (optional)
gender (optional)
id
instagram_id (optional)
is_spam (optional)
language (optional)
last_name (optional)
line_id (optional)
organisation (optional)
phone (optional)
status
away
online
invisible
telegram_id (optional)
timezone (optional)
Double Timezone in hours format: double
twitter_id (optional)
updated_at (optional)
Date Date of update format: date-time
user (optional)
viber_id (optional)
visitor_id (optional)
chat_contact collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
amount
Long Amount of the package format: int64
cpc (optional)
Double CPC of the package format: double
price
Double Price of the package format: double
bot_questions (optional)
Long Maximum number of questions per bot for the plan format: int64
bots (optional)
Long Maximum number of bots allowed for the plan format: int64
price
white_label
Boolean Flag whether subscription plan is white label
Dimensions
height
Long Height format: int64
width
Domain (default view)
bots (optional)
created_at
Date Date of creation format: date-time
deployment_records (optional)
id
knowledge_base (optional)
name
status (optional)
type (optional)
updated_at (optional)
Date Date of update format: date-time
verification_records (optional)
A backoffice domain collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
status (optional)
pending
verified
deployed
failed
created
type
Domain create payload
knowledge_base (optional)
name
type
landing
deployment
knowledge_base
Domain status
description (optional)
id
0
1
2
3
4
name (optional)
value
pending
verified
deployed
failed
created
Domain type
description (optional)
id
0
1
2
name (optional)
value
landing
deployment
knowledge_base
domain collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
frontend_hostname
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
token
verification_prefix
Download (default view)
created_at
error (optional)
id
name (optional)
progress (optional)
Double Download preparation progress format: double
status
created
failed
finished
updated_at (optional)
url (optional)
Download collection payload
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
status (optional)
created
failed
finished
Download delete payload
ids (optional)
search (optional)
status (optional)
created
failed
finished
download collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
address
String Email address format: email
created_at
id
is_default
name
status
updated_at (optional)
Email address create payload
Email address update payload
Email from address status
description (optional)
id
0
1
2
name (optional)
value
pending
failed
verified
Organisation email settings
incoming_address (optional)
status
Organisation email settings payload
default_from_address (optional)
String Default
from address id
default_reply_to_address (optional)
String Default
reply to address id
status (optional)
healthy
review
paused
Email from address (default view)
address
created_at
Date Date of creation format: date-time
id
is_default
Boolean Flag whether this address is selected as default
name
status
updated_at (optional)
Date Date of update format: date-time
verification_records (optional)
email_from_address collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Email from address (default view)
address
created_at
Date Date of creation format: date-time
id
is_default
Boolean Flag whether this address is selected as default
name
updated_at (optional)
Date Date of update format: date-time
email_replyto_address collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Form body value
description (optional)
id (optional)
key
name
value (optional)
Form content type
description (optional)
id
0
1
name (optional)
value
form
form_url_encoded
Freshdesk integration payload
Frontend bot chat text (default view)
app_id
language
languages
text
Gender
description (optional)
id
0
1
name (optional)
value
male
female
Google drive integration payload
Integration (default view)
auth_url (optional)
azure_cognitive_services_speech (optional)
config_url (optional)
created_at
freshdesk (optional)
google_drive (optional)
id
name
needs_authorization (optional)
open_ai (optional)
status
type
updated_at (optional)
Integration collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Integration config for Azure cognitive services speech
Integration config for Freshdesk
Integration config for Google Drive
Integration config for OpenAI
Integration (reference view)
Integration status
description (optional)
id
0
1
name (optional)
value
created
active
Integration type
article_url
category
description (optional)
features (optional)
id
0
1
2
3
logo
name (optional)
tags (optional)
value
freshdesk
google_drive
open_ai
azure_cognitive_services_speech
Integration type category
description (optional)
id
0
1
2
3
name (optional)
value
crm
storage
ai
cloud
Integration type collection payload
category (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
tag (optional)
Integration type feature
description (optional)
id
0
1
2
3
4
5
6
7
8
name (optional)
value
import_knowledge_base
export_contact
import_live_chat
store_bot_response
complete_text
generate_image
transcribe_audio
translate_audio
text_to_speech
Integration type tag
description (optional)
id
0
1
2
3
name (optional)
value
crm
storage
ai
cloud
Integration update payload
azure_cognitive_services_speech (optional)
freshdesk (optional)
google_drive (optional)
name
open_ai (optional)
integration collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Integration config (default view)
azure_cognitive_services_speech (optional)
freshdesk (optional)
google_drive (optional)
integration (optional)
open_ai (optional)
integration_type collection (default view)
categories (optional)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
tags (optional)
Knowledge base article collection payload
ids (optional)
is_draft (optional)
page_number (optional)
page_size (optional)
search (optional)
section (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Knowledge base article delete payload
ids (optional)
is_draft (optional)
search (optional)
section (optional)
Knowledge base article payload
aliases (optional)
categories (optional)
has_toc (optional)
id (optional)
String ID of a knowledge base article
is_draft (optional)
key
resources (optional)
section (optional)
slug
tags (optional)
text
title
updated_at (optional)
Date Date of update format: date-time
Knowledge base article replace payload
Knowledge base article resource
created_at (optional)
Date Date of creation format: date-time
id (optional)
String ID of a knowledge base section
key
name (optional)
src (optional)
title (optional)
type
image
audio_file
video_file
file
updated_at (optional)
Date Date of update format: date-time
Knowledge base collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Knowledge base import collection payload
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Knowledge base import freshdesk
categories (optional)
custom_domain (optional)
Knowledge base import payload
freshdesk (optional)
integration
is_append_only (optional)
Knowledge base import status
description (optional)
id
0
1
2
3
name (optional)
value
created
processing
failed
completed
Knowledge base menu item
article (optional)
created_at (optional)
Date Date of creation format: date-time
description (optional)
id (optional)
String ID of a knowledge base menu item
key
section (optional)
Long Section key format: int64
title (optional)
type
section
article
url
updated_at (optional)
Date Date of update format: date-time
url (optional)
Knowledge base payload
css (optional)
description (optional)
favicon (optional)
footer_html (optional)
header_html (optional)
languages (optional)
logo (optional)
menu_items (optional)
name
sections (optional)
show_edit_links (optional)
title (optional)
title_addition (optional)
Knowledge base search payload
knowledge_base
knowledge_base_sections (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Knowledge base section
aliases (optional)
created_at (optional)
Date Date of creation format: date-time
description (optional)
general_url (optional)
String Section general domain URL
id (optional)
String ID of a knowledge base section
key
parent (optional)
Long Parent section key format: int64
slug
title (optional)
updated_at (optional)
Date Date of update format: date-time
url (optional)
Knowledge base status
description (optional)
id
0
1
2
3
name (optional)
value
created
deploying
deployment_failed
deployed
Knowledge base (default view)
created_at
Date Date of creation format: date-time
css (optional)
deployment_error (optional)
description (optional)
favicon (optional)
footer_html (optional)
general_url (optional)
header_html (optional)
id
languages (optional)
logo (optional)
menu_items (optional)
name
sections (optional)
show_edit_links (optional)
status (optional)
title (optional)
title_addition (optional)
updated_at (optional)
Date Date of update format: date-time
url (optional)
Knowledge base (reference view)
Knowledge base article (default view)
aliases (optional)
categories (optional)
created_at
Date Date of creation format: date-time
general_url (optional)
String Article general domain URL
has_toc (optional)
id
String ID of a knowledge base article
is_draft (optional)
key
order (optional)
resources (optional)
section (optional)
slug (optional)
tags (optional)
text (optional)
title (optional)
updated_at (optional)
Date Date of update format: date-time
url (optional)
knowledge_base_article collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
knowledge_base collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Knowledge base import (default view)
created_at
Date Date of creation format: date-time
error (optional)
freshdesk (optional)
id
String ID of a knowledge base import
integration (optional)
is_append_only (optional)
status (optional)
updated_at (optional)
Date Date of update format: date-time
knowledge_base_import collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Knowledge base search result item (default view)
description (optional)
id
image (optional)
text (optional)
title
url (optional)
knowledge_base_search_result_item collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Language
code
ar-ae
ar-eg
ar-sa
az-az
bg-bg
bn-bd
bn-in
ca-ad
ca-es
ca-fr
ca-it
cs-cz
da-dk
da-gl
de-de
el-cy
el-gr
en-ca
en-gb
en-us
es-es
et-ee
fa-ir
fi-fi
fr-fr
ga-ie
he-il
hi-in
hr-ba
hr-hr
ht-ht
hu-hu
hy-am
id-id
it-it
ja-jp
ka-ge
km-kh
ko-kp
ko-kr
ky-kg
lt-lt
lv-lv
ms-bn
ms-my
ms-sg
mt-mt
my-mm
nb-no
nb-sj
ne-in
ne-np
nl-nl
nt-nt
pa-in
pl-pl
pt-br
pt-pt
ro-ro
ru-ru
sk-sk
sl-si
sl-sl
sr-ba
sr-me
sr-rs
sr-xk
sv-ax
sv-fi
sv-se
th-th
ti-er
ti-et
tr-tr
uk-ua
vi-vn
zh-cn
zh-hk
zh-mo
zh-sg
zh-tw
name (optional)
Link target
description (optional)
id
0
1
2
3
name (optional)
value
_self
_blank
_parent
_top
Live chat assign payload
agent_groups (optional)
agents (optional)
filter (optional)
Live chat audio transcription settings
integration (optional)
is_enabled (optional)
Live chat attachment payload
Live chat attachment settings
audio_transcription (optional)
Live chat automation rule
actions
condition (optional)
condition_field (optional)
condition_operator (optional)
created_at (optional)
Date Created format: date-time
description (optional)
String Description for backoffice reference
id (optional)
is_enabled (optional)
key
name (optional)
String Name for backoffice reference
stop_processing (optional)
trigger_type
chat_created
chat_closed
chat_reopened
chat_marked_spam
chat_unmarked_spam
chat_message_created
chat_periodic_timer
organisation_periodic_timer
chat_contact_responded
chat_agent_responded
chat_handed_over_to_bot
updated_at (optional)
Date Updated format: date-time
Live chat automation rule action
agent_status (optional)
away
online
invisible
assign_agent_groups (optional)
assign_agents (optional)
basic_auth (optional)
created_at (optional)
Date Created format: date-time
email_bcc (optional)
email_cc (optional)
email_from (optional)
email_reply_to (optional)
String Email reply to addresses
email_subject (optional)
email_to (optional)
form_body_values (optional)
form_content_type (optional)
form
form_url_encoded
forward_agent_groups (optional)
forward_agents (optional)
forward_emails (optional)
google_drive_spreadsheet_document (optional)
google_drive_spreadsheet_integration (optional)
google_drive_spreadsheet_list (optional)
headers (optional)
id (optional)
json_body (optional)
key
rule (optional)
slack_channel_name (optional)
text (optional)
type
assign
close
reopen
mark_spam
unmark_spam
forward
email
json
slack
zapier
integromat
agent_status
form
google_drive_spreadsheet
updated_at (optional)
Date Updated format: date-time
url (optional)
variables (optional)
Live chat automation rule action header
id (optional)
key
name
value (optional)
Live chat automation rule action log item collection payload
action (optional)
begin (optional)
chat (optional)
end (optional)
ids (optional)
page_number (optional)
page_size (optional)
rule (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Live chat automation rule action log item reference type (workaround)
action (optional)
created_at
id
is_error
Live chat automation rule condition operator field
description (optional)
id
0
1
2
3
4
5
6
7
8
9
10
12
11
13
14
15
16
17
18
19
20
21
name (optional)
value
chatSubject
chatDescription
chatMessageText
chatUpdatedSince
chatStatus
chatState
chatIsSpam
chatAssignedAgentGroup
chatAssignedAgent
chatContactContinent
chatContactCountry
chatContactCity
chatContactState
chatPageHostName
chatPagePath
chatPageURL
chatReferrer
chatDeviceType
dayOfWeek
time
day
month
Live chat automation rule condition operator
description (optional)
id
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
18
17
19
name (optional)
value
=
!=
startsWith
notStartsWith
endsWith
notEndsWith
matchesRegEx
notMatchesRegEx
iMatchesRegEx
notIMatchesRegEx
<
>
<=
>=
in
notIn
contains
iContains
notContains
notIContains
Live chat automation rule reference
Live chat canned response collection payload
categories (optional)
ids (optional)
is_preview (optional)
is_spam (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Live chat canned response payload
categories (optional)
name
text (optional)
text_variables (optional)
type
text
Live chat canned response render payload
Live chat collection payload
agent (optional)
assigned_agent (optional)
assigned_agent_group (optional)
begin (optional)
bot (optional)
channel_mode (optional)
contact (optional)
end (optional)
ids (optional)
is_spam (optional)
page_number (optional)
page_size (optional)
priority (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
state (optional)
status (optional)
tags (optional)
translation_mode (optional)
Live chat import collection payload
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Live chat import freshdesk
filter (optional)
String Ticket filter to use for the import
Live chat import payload
freshdesk (optional)
integration
is_append_only (optional)
Live chat import status
description (optional)
id
0
1
2
3
name (optional)
value
created
processing
failed
completed
Live chat merge payload
add_bcc (optional)
Boolean Add BCC from the merged tickets
add_cc (optional)
Boolean Add CC from the merged tickets
ids (optional)
skip_notification (optional)
Live chat message collection payload
page_number (optional)
page_size (optional)
sort_order (optional)
asc
desc
Live chat message payload
attachments (optional)
contact_bcc (optional)
contact_cc (optional)
text (optional)
type (optional)
text
Live chat payload
agents (optional)
channel_mode (optional)
bot
email
contact (optional)
description (optional)
is_spam (optional)
language (optional)
priority (optional)
unset
low
medium
high
urgent
response (optional)
skip_notification (optional)
state (optional)
new
agent_responded
contact_responded
status (optional)
new
open
closed
merged
subject (optional)
tags (optional)
translation_mode (optional)
disabled
automatic
Live chat reference
bot (optional)
id
number
Long Number format: int64
organisation (optional)
subject (optional)
Live chat search view collection payload
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Live chat search view payload
description (optional)
filter (optional)
is_shared (optional)
name
Live chat settings
agent_status (optional)
String Global organization Agent agent status
away
online
invisible
attachment (optional)
automation_rules (optional)
chat_agent_joined_message (optional)
chat_agent_left_message (optional)
chat_channel_email_message (optional)
chat_closed_email_message (optional)
chat_closed_message (optional)
chat_created_email_message (optional)
chat_created_message (optional)
chat_handed_over_to_bot_message (optional)
chat_merged_from_email_message (optional)
chat_merged_from_message (optional)
chat_merged_to_email_message (optional)
chat_merged_to_message (optional)
chat_message_variables (optional)
chat_offline_timeout (optional)
Integer Chat offline timeout in minutes
chat_reopened_email_message (optional)
chat_reopened_message (optional)
languages (optional)
translation_mode (optional)
disabled
automatic
user_avatar (optional)
String Fallback avatar for the user
translation_mode
disabled
automatic
Live chat update collection payload
contact (optional)
ids (optional)
is_spam (optional)
search (optional)
skip_notification (optional)
status (optional)
with_contact (optional)
Live chat (default view)
agents
assigned_agent_groups
assigned_agents
automation_rule_action_log_items (optional)
bot (optional)
bot_data (optional)
channel_mode
bot
email
contact
contact_bcc (optional)
contact_cc (optional)
created_at
Date Date of creation format: date-time
description (optional)
id
is_new (optional)
is_spam (optional)
language (optional)
merged_from (optional)
merged_to (optional)
messages
number
Long Number format: int64
organisation
priority
unset
low
medium
high
urgent
response (optional)
start
Date Date of start format: date-time
state
new
agent_responded
contact_responded
status
new
open
closed
merged
stop (optional)
Date Date of stop format: date-time
subject
tags (optional)
translated_description (optional)
translated_subject (optional)
translation_mode
disabled
automatic
updated_at (optional)
Date Date of update format: date-time
Live_chat_attachment media type (default view)
created_at
id
name
params
transcript (optional)
String Transcript of the attachment
translated_transcript (optional)
type
updated_at (optional)
url
Live chat automation rule action log item (default view)
action (optional)
chat (optional)
created_at
id
is_error
request
response
live_chat_automation_rule_action_log_item collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Live chat canned response (default view)
categories (optional)
created_at
Date Date of creation format: date-time
id
name
organisation
text (optional)
type
text
updated_at (optional)
Date Date of update format: date-time
live_chat_canned_response collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
live_chat collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Live chat import (default view)
created_at
Date Date of creation format: date-time
error (optional)
freshdesk (optional)
id
integration (optional)
is_append_only (optional)
status (optional)
updated_at (optional)
Date Date of update format: date-time
live_chat_import collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Live chat message (default view)
agent (optional)
attachments (optional)
bot (optional)
channel
facebook
web
twilio_whatsapp
line
message_bird
telegram
email
viber
dialog360
instagram
twitter
google_business_messages
chat
contact (optional)
contact_bcc (optional)
contact_cc (optional)
created_at
Date Date of creation format: date-time
delivery_error (optional)
has_original_text (optional)
id
organisation
original_text (optional)
quote_text (optional)
source
person
bot
status
created
sent
delivered
delivery_failed
seen
text (optional)
translated_text (optional)
type
text
updated_at (optional)
Date Date of update format: date-time
live_chat_message collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Search view (default view)
created_at
Date Date of creation format: date-time
description (optional)
filter (optional)
id
is_read_only (optional)
is_shared (optional)
name
updated_at (optional)
Date Date of update format: date-time
live_chat_search_view collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Lock (default view)
created_at
id
is_own
object_id
object_type
BoUser
Organisation
Bot
FromAddress
ReplyToAddress
Domain
BotChannel
Contact
BotChannelPost
KnowledgeBaseArticle
KnowledgeBaseSection
KnowledgeBase
LiveChatCannedResponseCategory
LiveChatCannedResponse
KnowledgeBaseCategory
KnowledgeBaseTag
LiveChatTag
Integration
FreshdeskIntegrationSolutionCategory
FreshdeskIntegrationFilter
IntegrationType
LiveChat
Agent
AgentGroup
LiveChatSearchView
GoogleDriveIntegrationDocument
GoogleDriveIntegrationDocumentList
BotStep
BotChannelLocation
OpenAIIntegrationAssistant
Enum
SubscriberGroup
user (optional)
Object delete lock payload
force (optional)
object_id
object_type
BoUser
Organisation
Bot
FromAddress
ReplyToAddress
Domain
BotChannel
Contact
BotChannelPost
KnowledgeBaseArticle
KnowledgeBaseSection
KnowledgeBase
LiveChatCannedResponseCategory
LiveChatCannedResponse
KnowledgeBaseCategory
KnowledgeBaseTag
LiveChatTag
Integration
FreshdeskIntegrationSolutionCategory
FreshdeskIntegrationFilter
IntegrationType
LiveChat
Agent
AgentGroup
LiveChatSearchView
GoogleDriveIntegrationDocument
GoogleDriveIntegrationDocumentList
BotStep
BotChannelLocation
OpenAIIntegrationAssistant
Enum
SubscriberGroup
object_updated_at
Date Object updated at format: date-time
Object lock payload
object_id
object_type
BoUser
Organisation
Bot
FromAddress
ReplyToAddress
Domain
BotChannel
Contact
BotChannelPost
KnowledgeBaseArticle
KnowledgeBaseSection
KnowledgeBase
LiveChatCannedResponseCategory
LiveChatCannedResponse
KnowledgeBaseCategory
KnowledgeBaseTag
LiveChatTag
Integration
FreshdeskIntegrationSolutionCategory
FreshdeskIntegrationFilter
IntegrationType
LiveChat
Agent
AgentGroup
LiveChatSearchView
GoogleDriveIntegrationDocument
GoogleDriveIntegrationDocumentList
BotStep
BotChannelLocation
OpenAIIntegrationAssistant
Enum
SubscriberGroup
object_updated_at
Date Object updated at format: date-time
password
recaptcha_response
username
A login oauth callback confirm payload
A backoffice oauth login payload
provider
gplus
microsoftonline
facebook
recaptcha_response
Login provider
description (optional)
id
0
1
2
name (optional)
value
gplus
microsoftonline
facebook
Mail payload
Message (optional)
MessageId (optional)
Signature (optional)
SignatureVersion (optional)
SigningCertURL (optional)
Subject (optional)
SubscribeURL (optional)
Timestamp (optional)
Token (optional)
TopicArn (optional)
Type (optional)
UnsubscribeURL (optional)
Organisation notification settings notification
bots (optional)
array[Long] Bots to include in the reporting format: int64
daily (optional)
daily_subject (optional)
email (optional)
email_from (optional)
exclude_bots (optional)
array[Long] Bots to include in the reporting format: int64
id (optional)
monthly (optional)
monthly_subject (optional)
weekly (optional)
weekly_subject (optional)
Organisation notification settings payload
bots (optional)
array[Long] Bots to include in the reporting format: int64
daily (optional)
daily_subject (optional)
email (optional)
email_from (optional)
exclude_bots (optional)
array[Long] Bots to include in the reporting format: int64
id (optional)
monthly (optional)
monthly_subject (optional)
weekly (optional)
weekly_subject (optional)
Notification template
channel_type (optional)
email
created_at (optional)
Date Created format: date-time
id (optional)
live_chat_message_account (optional)
String Live chat message account notification template
live_chat_message_account_variables (optional)
array[String] Live chat message account notification template available variables
updated_at (optional)
Date Updated format: date-time
Object version collection payload
is_draft (optional)
object_id
object_type
BoUser
Organisation
Bot
FromAddress
ReplyToAddress
Domain
BotChannel
Contact
BotChannelPost
KnowledgeBaseArticle
KnowledgeBaseSection
KnowledgeBase
LiveChatCannedResponseCategory
LiveChatCannedResponse
KnowledgeBaseCategory
KnowledgeBaseTag
LiveChatTag
Integration
FreshdeskIntegrationSolutionCategory
FreshdeskIntegrationFilter
IntegrationType
LiveChat
Agent
AgentGroup
LiveChatSearchView
GoogleDriveIntegrationDocument
GoogleDriveIntegrationDocumentList
BotStep
BotChannelLocation
OpenAIIntegrationAssistant
Enum
SubscriberGroup
page_number (optional)
page_size (optional)
search (optional)
Object version payload
object_id
object_payload
object_type
BoUser
Organisation
Bot
FromAddress
ReplyToAddress
Domain
BotChannel
Contact
BotChannelPost
KnowledgeBaseArticle
KnowledgeBaseSection
KnowledgeBase
LiveChatCannedResponseCategory
LiveChatCannedResponse
KnowledgeBaseCategory
KnowledgeBaseTag
LiveChatTag
Integration
FreshdeskIntegrationSolutionCategory
FreshdeskIntegrationFilter
IntegrationType
LiveChat
Agent
AgentGroup
LiveChatSearchView
GoogleDriveIntegrationDocument
GoogleDriveIntegrationDocumentList
BotStep
BotChannelLocation
OpenAIIntegrationAssistant
Enum
SubscriberGroup
object_updated_at (optional)
Date Object updated at format: date-time
Object version (default view)
created_at
description (optional)
id
is_draft
object_id
object_payload
object_previous_payload (optional)
Object Object previous payload
object_type
BoUser
Organisation
Bot
FromAddress
ReplyToAddress
Domain
BotChannel
Contact
BotChannelPost
KnowledgeBaseArticle
KnowledgeBaseSection
KnowledgeBase
LiveChatCannedResponseCategory
LiveChatCannedResponse
KnowledgeBaseCategory
KnowledgeBaseTag
LiveChatTag
Integration
FreshdeskIntegrationSolutionCategory
FreshdeskIntegrationFilter
IntegrationType
LiveChat
Agent
AgentGroup
LiveChatSearchView
GoogleDriveIntegrationDocument
GoogleDriveIntegrationDocumentList
BotStep
BotChannelLocation
OpenAIIntegrationAssistant
Enum
SubscriberGroup
user (optional)
object_version collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Offset unit
description (optional)
id
0
1
name (optional)
value
vh
px
OpenAI integration
automation_rules (optional)
organisation (optional)
OpenAI integration automation rule
actions
condition (optional)
condition_field (optional)
condition_operator (optional)
created_at (optional)
Date Created format: date-time
description (optional)
String Description for backoffice reference
id (optional)
is_enabled (optional)
key
name (optional)
String Name for backoffice reference
stop_processing (optional)
trigger_type
organisation_periodic_timer_daily
organisation_periodic_timer_weekly
organisation_periodic_timer_monthly
updated_at (optional)
Date Updated format: date-time
OpenAI integration automation rule action
crawl_update_assistant (optional)
created_at (optional)
Date Created format: date-time
google_drive_spreadsheet_update_assistant (optional)
id (optional)
key
response_assessment (optional)
rule (optional)
type
crawl_update_assistant
response_assessment
google_drive_spreadsheet_update_assistant
updated_at (optional)
Date Updated format: date-time
variables (optional)
OpenAI integration automation rule action crawl and update assistant details
assistant
detect_charset (optional)
disallowed_url_filters (optional)
filename (optional)
format
pdf
markdown
ignore_robots_txt (optional)
max_body_size (optional)
Long Max body size format: int64
max_depth (optional)
Long Max depth format: int64
url
String URL to crawl format: uri
url_filters (optional)
user_agent (optional)
OpenAI integration automation rule action update assistant from google drive spreadsheet details
assistant
document
integration
lists (optional)
OpenAI integration automation rule action log item collection payload
action (optional)
begin (optional)
end (optional)
ids (optional)
page_number (optional)
page_size (optional)
rule (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
OpenAI integration automation rule action response assessment details
OpenAI integration automation rule condition operator field
description (optional)
id
18
19
20
21
name (optional)
value
dayOfWeek
time
day
month
OpenAI integration automation rule condition operator
description (optional)
id
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
18
17
19
name (optional)
value
=
!=
startsWith
notStartsWith
endsWith
notEndsWith
matchesRegEx
notMatchesRegEx
iMatchesRegEx
notIMatchesRegEx
<
>
<=
>=
in
notIn
contains
iContains
notContains
notIContains
OpenAI integration automation rule reference
OpenAI integration payload
api_key (optional)
automation_rules (optional)
organisation (optional)
OpenAI integration automation rule action log item (default view)
action (optional)
created_at
id
is_error
request
response
open_ai_integration_automation_rule_action_log_item collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
OptionalTranslation
ar_ae (optional)
ar_eg (optional)
ar_sa (optional)
az_az (optional)
bg_bg (optional)
bn_bd (optional)
bn_in (optional)
ca_ad (optional)
ca_es (optional)
ca_fr (optional)
ca_it (optional)
cs_cz (optional)
da_dk (optional)
da_gl (optional)
de_de (optional)
el_cy (optional)
el_gr (optional)
en_ca (optional)
en_gb (optional)
en_us (optional)
es_es (optional)
et_ee (optional)
fa_ir (optional)
fi_fi (optional)
fr_fr (optional)
ga_ie (optional)
he_il (optional)
hi_in (optional)
hr_ba (optional)
hr_hr (optional)
ht_ht (optional)
hu_hu (optional)
hy_am (optional)
id_id (optional)
it_it (optional)
ja_jp (optional)
ka_ge (optional)
km_kh (optional)
ko_kp (optional)
ko_kr (optional)
ky_kg (optional)
lt_lt (optional)
lv_lv (optional)
ms_bn (optional)
ms_my (optional)
ms_sg (optional)
mt_mt (optional)
my_mm (optional)
nb_no (optional)
nb_sj (optional)
ne_in (optional)
ne_np (optional)
nl_nl (optional)
nt_nt (optional)
pa_in (optional)
pl_pl (optional)
pt_br (optional)
pt_pt (optional)
ro_ro (optional)
ru_ru (optional)
sk_sk (optional)
sl_si (optional)
sl_sl (optional)
sr_ba (optional)
sr_me (optional)
sr_rs (optional)
sr_xk (optional)
sv_ax (optional)
sv_fi (optional)
sv_se (optional)
th_th (optional)
ti_er (optional)
ti_et (optional)
tr_tr (optional)
uk_ua (optional)
vi_vn (optional)
zh_cn (optional)
zh_hk (optional)
zh_mo (optional)
zh_sg (optional)
zh_tw (optional)
An organisation (default view)
accepted_dpa (optional)
String DPA which an organisation had accepted
accepted_dpa_at (optional)
Date Date and time when an organisation had accepted DPA format: date-time
accepted_privacy (optional)
String Privacy Policy which an organisation had accepted
accepted_toc (optional)
String T&C which an organisation had accepted
accepted_toc_at (optional)
Date Date and time when an organisation had accepted T&C format: date-time
address (optional)
address2 (optional)
billing_settings (optional)
city (optional)
country (optional)
created_at
Date Date of creation format: date-time
email_settings (optional)
finance_email (optional)
String Finance email format: email
id
is_accepted_dpa
Boolean Flag whether DPA was accepted by the organisation
is_accepted_toc
Boolean Flag whether T&C was accepted by the organisation
is_beta (optional)
Boolean Flag whether the organisation is a beta program participant
is_unlimited_bots (optional)
Boolean Flag whether the organisation has unlimited bots
kvk_number (optional)
language (optional)
live_chat_settings (optional)
logo (optional)
String Logo of an organisation
name (optional)
String Name of an organisation
notification_settings (optional)
notification_templates (optional)
phone (optional)
postal_code (optional)
referrer (optional)
slug (optional)
String Slug of an organisation
state (optional)
subscription (optional)
subscription_order (optional)
subscription_usage (optional)
support_url (optional)
String Support URL format: uri
timezone (optional)
updated_at (optional)
Date Date of update format: date-time
vat_number (optional)
website (optional)
Organisation activate callback
body (optional)
Object Body of the request in the form of dotted key-value pairs. Variable {{}} syntax is supported. Currently, those variables are supported: organisationID, organisationName, botID, botName, botEmbedCode.
headers (optional)
url
Organisation activate payload
bot_status (optional)
String Bot status to set for the new bot
active
inactive
bot_template_name
String Bot template name to use for the bot to be created in the new organisation
callback (optional)
organisation
A backoffice organisation collection payload
page_number (optional)
page_size (optional)
referrer (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Organisation create payload
address
address2 (optional)
billing_settings (optional)
city
copy_domains (optional)
copy_email_addresses (optional)
copy_integrations (optional)
copy_referrer_members (optional)
country
domain (optional)
finance_email (optional)
String Finance email format: email
ignore_notification_templates (optional)
is_accepted_dpa
Boolean Flag whether DPA was accepted by the organisation
is_accepted_toc
Boolean Flag whether T&C was accepted by the organisation
is_beta (optional)
Boolean Flag whether the organisation is a beta program participant
is_unlimited_bots (optional)
Boolean Flag whether the organisation has unlimited bots
kvk_number (optional)
language (optional)
cs-cz
de-de
en-us
es-es
fr-fr
it-it
nl-nl
pt-br
ru-ru
uk-ua
logo (optional)
String Logo of an organisation
name
String Name of an organisation
notification_settings (optional)
notification_templates (optional)
phone
postal_code (optional)
referrer (optional)
slug (optional)
String Slug of an organisation
state (optional)
support_url (optional)
String Support URL format: uri
timezone (optional)
vat_number (optional)
website (optional)
Organisation deactivate payload
Backoffice user member settings live chat
id (optional)
list (optional)
Backoffice user member settings live chat list
Backoffice user member settings payload
A backoffice organisation membership collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Organisation membership role
description (optional)
id
0
1
2
4
name (optional)
value
member
admin
read_only
agent
Organisation membership update payload
propagate_to_sub_organisations (optional)
Boolean Propagate membership to sub-organisations
role
member
admin
read_only
agent
An organisation (reference view)
id
is_accepted_dpa
Boolean Flag whether DPA was accepted by the organisation
is_accepted_toc
Boolean Flag whether T&C was accepted by the organisation
name (optional)
String Name of an organisation
slug (optional)
String Slug of an organisation
subscription (optional)
A backoffice organisation referral payment collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
An organisation referral payment payload
Organisation subscription status
description (optional)
id
0
1
2
name (optional)
value
pending
active
inactive
Organisation subscription usage
Organisation update payload
address (optional)
address2 (optional)
billing_settings (optional)
city (optional)
country (optional)
email_settings (optional)
finance_email (optional)
String Finance email format: email
ignore_notification_templates (optional)
is_accepted_dpa (optional)
Boolean Flag whether DPA was accepted by the organisation
is_accepted_toc (optional)
Boolean Flag whether T&C was accepted by the organisation
is_beta (optional)
Boolean Flag whether the organisation is a beta program participant
is_unlimited_bots (optional)
Boolean Flag whether the organisation has unlimited bots
kvk_number (optional)
language (optional)
cs-cz
de-de
en-us
es-es
fr-fr
it-it
nl-nl
pt-br
ru-ru
uk-ua
live_ (optional)
live_chat_settings (optional)
logo (optional)
String Logo of an organisation
name (optional)
String Name of an organisation
notification_settings (optional)
notification_templates (optional)
phone (optional)
postal_code (optional)
referrer (optional)
slug (optional)
String Slug of an organisation
state (optional)
support_url (optional)
String Support URL format: uri
timezone (optional)
vat_number (optional)
website (optional)
Organisation activation result (default view)
An organisation billing settings (default view)
auto_chat_package (optional)
Boolean Adjust chat package automatically
id
mandate_payment (optional)
payer (optional)
payment_customer_id (optional)
payment_mandate_id (optional)
payment_type
organisation collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
A backoffice user member settings (default view)
id
live_chat (optional)
organisation
Organisation membership (default view)
id
organisation
permissions (optional)
role
user (optional)
Organisation membership (reference view)
id
organisation
permissions (optional)
role
user (optional)
organisation_membership collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Organisation referral (default view)
attracted_free
Long Number of attracted organisations with a free plan format: int64
attracted_paid
Long Number of attracted organisations with a paid plan format: int64
earned
Double Earned amount format: double
link
organisation
paid
Double Paid amount format: double
Organisation referral payment (default view)
amount
created_at
Date Date of creation format: date-time
id
organisation
updated_at (optional)
Date Date of update format: date-time
organisation_referral_payment collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
An organisation subscription (default view)
bot_questions (optional)
bots (optional)
chat_package
end (optional)
id
is_custom
is_free
notified_pricing_update_at (optional)
order (optional)
period
plan
pricing_update_at (optional)
start
status
tax
total
total_with_tax
An organisation subscription (reference view)
Password score payload
password
user_inputs (optional)
Password score (default view)
Payment (default view)
amount
created_at
Date Date of creation format: date-time
description
error (optional)
id
invoice (optional)
method (optional)
provider_customer_id (optional)
provider_id (optional)
provider_payment_url (optional)
purpose
recurring_type (optional)
status
updated_at (optional)
Date Date of update format: date-time
Payment collection payload
organisation_id (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Payment create payload
preferred_payment_method (optional)
Payment mandate status
description (optional)
id
0
1
2
name (optional)
value
valid
pending
invalid
Payment method
description (optional)
id
0
1
2
3
5
4
6
7
8
9
10
11
12
13
14
15
16
17
18
name (optional)
value
bancontact
banktransfer
belfius
bitcoin
directdebit
creditcard
giftcard
ideal
inghomepay
kbc
paypal
paysafecard
sofort
applepay
eps
giropay
mybank
przelewy24
mistercash
Payment purpose
description (optional)
id
1
2
0
name (optional)
value
mandate
invoice
unknown
Payment recurring type
description (optional)
id
0
1
name (optional)
value
first
recurring
Payment status
description (optional)
id
0
1
2
3
4
5
6
7
8
name (optional)
value
open
canceled
pending
expired
failed
refunded
paid
paidout
charged_back
Payment update status payload
payment collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Payment mandate (default view)
created_at
Date Date of creation format: date-time
customer_id
id
method
selected
Boolean Flag whether this mandate is selected to use
status
payment_mandate collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Backoffice user permission
description (optional)
id
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
11
21
22
29
31
32
33
34
35
37
39
38
40
41
45
25
26
30
27
36
0
0
0
0
0
0
0
0
0
0
0
0
0
0
name (optional)
value
BotCreate
BotGetOne
BotUpdateOne
BotGetList
BotDeleteOne
BotReindexOne
BotChannelCreate
BotChannelGetOne
BotChannelUpdateOne
BotChannelGetList
BotChannelDeleteOne
BotResponseActionLogItemGetOne
BotResponseActionLogItemGetList
BotVariableLogItemGetOne
BotVariableLogItemGetList
LiveChatCreate
LiveChatGetOne
LiveChatUpdateOne
LiveChatGetList
LiveChatDeleteOne
LiveChatSearchViewCreate
LiveChatSearchViewGetOne
LiveChatSearchViewUpdateOne
LiveChatSearchViewGetList
LiveChatSearchViewDeleteOne
LiveChatImportCreate
LiveChatImportGetOne
LiveChatImportGetList
LiveChatAutomationRuleActionLogItemGetOne
LiveChatAutomationRuleActionLogItemGetList
OpenAIIntegrationAutomationRuleActionLogItemGetOne
OpenAIIntegrationAutomationRuleActionLogItemGetList
CampaignAutomationRuleActionLogItemGetOne
CampaignAutomationRuleActionLogItemGetList
ObjectLockForceDeleteOne
AgentCreate
AgentGetOne
AgentUpdateOne
AgentGetList
AgentDeleteOne
AgentGroupCreate
AgentGroupGetOne
AgentGroupUpdateOne
AgentGroupGetList
AgentGroupDeleteOne
IntegrationCreate
IntegrationGetOne
IntegrationUpdateOne
IntegrationGetList
IntegrationDeleteOne
LiveChatCannedResponseCreate
LiveChatCannedResponseGetOne
LiveChatCannedResponseUpdateOne
LiveChatCannedResponseGetList
LiveChatCannedResponseDeleteOne
KnowledgeBaseCreate
KnowledgeBaseGetOne
KnowledgeBaseUpdateOne
KnowledgeBaseGetList
KnowledgeBaseDeleteOne
KnowledgeBaseReindexOne
DownloadGetOne
DownloadGetList
DownloadDeleteOne
BotTemplateGetOne
BotTemplateGetList
BoUserInviteCreate
BoUserInviteGetOne
BoUserInviteGetList
BoUserInviteDeleteOne
ResponseGetOne
ResponseUpdateOne
ResponseGetList
ResponseDeleteOne
ResponseSendNotification
BotBatchUpdateGetOne
BotBatchUpdateUpdateOne
BotBatchUpdateGetList
BotBatchUpdateDeleteOne
ContactCreate
ContactGetOne
ContactUpdateOne
ContactGetList
ContactDeleteOne
FeedbackCreate
FeedbackGetOne
FeedbackUpdateOne
FeedbackGetList
FeedbackDeleteOne
OrganisationCreate
OrganisationManageBilling
OrganisationManageEmail
OrganisationManageDomain
OrganisationMemberGetList
OrganisationManageMembers
OrganisationGetOne
OrganisationUpdateOne
OrganisationUpdateSubscriptionOne
OrganisationGetList
OrganisationUpdatePaymentType
OrganisationUpdateReferrer
OrganisationReferralPaymentCreate
OrganisationDeleteOne
PaymentUpdateStatus
PaymentGetOne
PaymentGetList
SubscriberGetOne
SubscriberGetList
SubscriberDeleteOne
SubscriberGroupCreate
SubscriberGroupGetOne
SubscriberGroupUpdateOne
SubscriberGroupGetList
SubscriberGroupDeleteOne
CampaignCreate
CampaignGetOne
CampaignUpdateOne
CampaignGetList
CampaignDeleteOne
SubscriptionOrderCreate
SubscriptionOrderGetOne
SubscriptionOrderUpdateOne
SubscriptionOrderGetList
SubscriptionOrderAdmin
SubscriptionInvoiceGetOne
SubscriptionInvoiceUpdateOne
SubscriptionInvoiceDeleteOne
SubscriptionInvoiceGetList
SubscriptionInvoiceGenerate
SubscriptionInvoiceSend
SubscriptionInvoiceCreatePayment
SubscriptionPlanFeatureWhiteLabel
SubscriptionPlanFeatureReferral
SubscriptionPlanFeatureChannelFacebook
SubscriptionPlanFeatureChannelFacebookCommentTrigger
SubscriptionPlanFeatureChannelFacebookCommentTriggerReply
SubscriptionPlanFeatureChannelTwilioWhatsapp
SubscriptionPlanFeatureChannelLine
SubscriptionPlanFeatureChannelMessageBird
SubscriptionPlanFeatureChannelTelegram
SubscriptionPlanFeatureChannelViber
SubscriptionPlanFeatureChannelInstagram
SubscriptionPlanFeatureChannelDialog360
SubscriptionPlanFeatureChannelTwitter
SubscriptionPlanFeatureChannelGoogleBusinessMessages
SubscriptionPlanFeatureCampaign
SubscriptionPlanFeatureAgency
SubscriptionPlanFeatureGeneralizedDomain
SubscriptionPlanFeatureDeploymentDomain
SubscriptionPlanFeatureLiveChat
SubscriptionPlanFeatureKnowledgeBase
SubscriptionVoucherGroupCreate
SubscriptionVoucherGroupGetOne
SubscriptionVoucherGroupUpdateOne
SubscriptionVoucherGroupGetList
SubscriptionVoucherGetOne
SubscriptionVoucherGetList
BoUserGetOne
BoUserManageActiveOne
BoUserUpdateUsernameOne
BoUserUpdateOne
BoUserDeleteOne
BoUserGetList
BoUserCreate
BoUserDelete
Point
is_mirrored (optional)
x
y
Post-init bot behaviour condition fields
description (optional)
id
1
2
3
5
6
7
8
9
12
13
14
15
name (optional)
value
pageHostName
pagePath
pageURL
dayOfWeek
time
deviceType
day
month
isReturning
visitCount
elementVisible
timeSinceInit
enabled
privacy (optional)
terms (optional)
Recaptcha settings (default view)
Reputation status
description (optional)
id
0
1
2
name (optional)
value
healthy
review
paused
A backoffice user password reset confirmation payload
base_url (optional)
password
String Password of backoffice user
token
A backoffice user password reset request payload
base_url (optional)
recaptcha_response
username
String Username of backoffice user format: email
A backoffice username change confirmation payload
A backoffice username change request payload
username
String Username of backoffice user format: email
Message
SubscribeURL (optional)
Type
Sound notification
count (optional)
Long Number of times to play the sound format: int64
duration (optional)
Long Sound duration format: int64
frequency (optional)
Double Sound frequency format: double
gain (optional)
Double Gain of the sound format: double
interval (optional)
Long Interval between the sounds format: int64
is_enabled
sound_type
beep
type
bot_start
bot_step_answer
Sticky avatar animation
count (optional)
delay (optional)
duration (optional)
Long Duration format: int64
pattern (optional)
timing (optional)
Sticky avatar animation payload
count (optional)
delay (optional)
duration (optional)
Long Duration format: int64
pattern (optional)
fade_in_out
horizontal_flipping
vertical_flipping
horizontal_appearing
vertical_appearing
horizontal_3d_rotation
vertical_3d_rotation
explosion
barrel_roll
zoom_in_out
zoom_and_rotate
timing (optional)
ease
ease_in
ease_out
ease_in_out
linear
cubic_bezier
Bot sticky avatar popup
active_color (optional)
active_inverse_text_color (optional)
String Active inverse text color
auto_show (optional)
auto_show_mobile (optional)
auto_show_timeout (optional)
auto_show_timeout_mobile (optional)
Integer Auto show timeout on mobile
avatar (optional)
button
button_font_size (optional)
favicon_bubble (optional)
inverse_text_color (optional)
message_background (optional)
show_after_close (optional)
show_after_close_mobile (optional)
show_on_exit_intent (optional)
show_on_exit_intent_mobile (optional)
show_on_exit_intent_timeout (optional)
Integer Show on exit intent after given milliseconds
show_on_exit_intent_timeout_mobile (optional)
Integer Show on exit intent on mobile after given milliseconds
show_on_hover (optional)
text_color (optional)
text_font_size (optional)
theme_color (optional)
title (optional)
Bot sticky avatar popup behaviour
active_color (optional)
active_inverse_text_color (optional)
String Active inverse text color
auto_show (optional)
auto_show_mobile (optional)
auto_show_timeout (optional)
auto_show_timeout_mobile (optional)
Integer Auto show timeout on mobile
avatar (optional)
button (optional)
button_font_size (optional)
favicon_bubble (optional)
inverse_text_color (optional)
message_background (optional)
show_after_close (optional)
show_after_close_mobile (optional)
show_on_exit_intent (optional)
show_on_exit_intent_mobile (optional)
show_on_exit_intent_timeout (optional)
Integer Show on exit intent after given milliseconds
show_on_exit_intent_timeout_mobile (optional)
Integer Show on exit intent on mobile after given milliseconds
show_on_hover (optional)
text_color (optional)
text_font_size (optional)
theme_color (optional)
title (optional)
Subscriber (default view)
bounces (optional)
channel (optional)
channel_type
facebook
web
twilio_whatsapp
line
message_bird
telegram
email
viber
dialog360
instagram
twitter
google_business_messages
complaints (optional)
contact
created_at
errors (optional)
group
id
sent (optional)
soft_bounces (optional)
status
unsubscribed
subscribed
disabled
subscribed_response (optional)
unsubscribed_response (optional)
updated_at (optional)
Subscriber collection payload
begin (optional)
bots (optional)
channel_types (optional)
channels (optional)
contacts (optional)
end (optional)
groups (optional)
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
statuses (optional)
Subscriber delete payload
begin (optional)
bots (optional)
channel_types (optional)
channels (optional)
contacts (optional)
end (optional)
groups (optional)
ids (optional)
search (optional)
statuses (optional)
SubscriberGroup collection payload
ids (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Subscriber group delete payload
ids (optional)
search (optional)
SubscriberGroup payload
description (optional)
name
subscriber collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
SubscriberGroup (default view)
created_at
description (optional)
id
name
updated_at (optional)
subscriber_group collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Subscription bill payload
chat_package
custom (optional)
period
month
year
three_year
lifetime
plan
voucher_code (optional)
bot_questions (optional)
Long Maximum allowed bot questions for this plan format: int64
bots (optional)
Long Maximum allowed bots for this plan format: int64
description
features (optional)
id
String ID of a subscription plan
is_free
Boolean Flag whether subscription plan is a free plan
name
old_price (optional)
Double Old price of a subscription plan format: double
price
Double Price of a subscription plan format: double
users (optional)
Long Maximum allowed users for this plan format: int64
white_label
Boolean Flag whether subscription plan is white label
Subscription invoice bill payload
month (optional)
Integer Optional month of the invoice. Defaults to current month.
organisation
year (optional)
Long Optional year of the invoice. Defaults to current year. format: int64
A backoffice subscription invoice collection payload
exclude_paid_externally (optional)
Boolean Exclude externally paid invoices
month (optional)
organisation_id (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
status (optional)
year (optional)
Subscription invoice rerender payload
Subscription invoice retry failed payments payload
Subscription invoice status
description (optional)
id
0
1
2
3
4
5
name (optional)
value
created
sent
processing
paid
cancelled
payment_failed
A backoffice subscription invoice update collection payload
exclude_paid_externally (optional)
Boolean Exclude externally paid invoices
ids (optional)
month (optional)
organisation_id (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
status (optional)
year (optional)
Subscription invoice update payload
status (optional)
created
sent
processing
paid
cancelled
payment_failed
Subscription order checkout payload
is_accepted
Boolean Flag whether the order is accepted
start (optional)
Date Optional start date for admin only use format: date-time
A backoffice subscription order collection payload
organisation_id (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Subscription order payload
chat_package
custom (optional)
end (optional)
Date Optional date and time of the subscription end format: date-time
organisation (optional)
String Optional organisation id
period
month
year
three_year
lifetime
plan
start (optional)
Date Date and time of the subscription start format: date-time
voucher_code (optional)
Subscription order status
description (optional)
id
0
1
2
3
4
5
name (optional)
value
created
completed
cancelled
stopped
upgraded
downgraded
Subscription order update payload
chat_package (optional)
custom (optional)
end (optional)
Date Optional date and time of the subscription end format: date-time
is_accepted (optional)
Boolean Flag whether the order is accepted
organisation (optional)
period (optional)
month
year
three_year
lifetime
plan (optional)
start (optional)
Date Date and time of the subscription start format: date-time
status (optional)
created
completed
cancelled
stopped
upgraded
downgraded
voucher_code (optional)
Subscription period
name
period
month
year
three_year
lifetime
Subscription plan chat package
amount
Long Amount estimation of chats 'included' in the package format: int64
cpc (optional)
Double CPC to calculate package amount format: double
description (optional)
id
name
old_price (optional)
Double Old price of the package format: double
price
Double Price of the package format: double
Subscription plan chat package collection
cpc (optional)
Double CPC for chats above the package amount format: double
description (optional)
items (optional)
remarks (optional)
Subscription plan feature
description (optional)
id
1
2
3
3
0
5
4
16
6
7
9
8
19
11
12
15
18
17
14
20
21
22
29
31
32
33
34
35
37
38
39
40
41
27
23
25
26
28
30
36
41
42
43
44
45
24
is_highlighted
Boolean Is subscription plan feature highlighted
name (optional)
value
unlimited_bots
advanced_step_types
custom_landing_page
conditional_jump_logic
custom_design
notifications
custom_behavior
external_services
reporting
scripting
unlimited_users
i18n
support_knowledge_base
white_label
email_support
custom_reporting
custom_branding
custom_integration
premium_support
external_chat_connection
referral
channel_facebook
channel_facebook_comment_trigger
channel_facebook_comment_trigger_reply
channel_twilio_whatsapp
channel_line
channel_message_bird
channel_telegram
channel_viber
channel_dialog360
channel_instagram
channel_twitter
channel_google_business_messages
live_chat
custom_bots
agency
generalized_domain
custom_domain
deployment_domain
knowledge_base
integration_freshdesk
integration_google_drive
integration_open_ai
integration_azure_cognitive_services_speech
campaign
all_features
Subscription usage quota status
description (optional)
id
0
1
2
name (optional)
value
ok
warning
error
A backoffice subscription voucher collection payload
group_id (optional)
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
A backoffice subscription voucher group collection payload
page_number (optional)
page_size (optional)
search (optional)
sort_on (optional)
sort_order (optional)
asc
desc
Subscription order payload
chat_package (optional)
custom (optional)
end (optional)
Date Optional date and time of the voucher group effective end format: date-time
name (optional)
String Subscription voucher group name
period (optional)
month
year
three_year
lifetime
plan (optional)
start (optional)
Date Optional date and time of the voucher group effective start format: date-time
status (optional)
created
prepared
active
inactive
Subscription voucher group status
description (optional)
id
0
1
2
3
name (optional)
value
created
prepared
active
inactive
A subscription bill (default view)
chat_package
currency
end (optional)
Date Optional date and time of the subscription end format: date-time
id
String ID of a subscription plan
is_custom
Boolean Flag whether subscription is custom
is_free
Boolean Flag whether subscription is free
needs_payment
Boolean Flag whether the subscription needs payment
period
plan
start (optional)
Date Date and time of the subscription start format: date-time
tax
Double Bill tax format: double
total
Double Bill total format: double
total_with_tax
Double Bill total including tax format: double
A subscription invoice (default view)
created_at
Date Date of creation format: date-time
end
error (optional)
id
String ID of a subscription invoice
items
month
number
String Number of a subscription invoice
organisation
start
status
tax
Double Bill tax format: double
total
Double Order total format: double
total_with_tax
Double Bill total including tax format: double
updated_at (optional)
Date Date of update format: date-time
vat_number (optional)
year
A subscription invoice (reference view)
id
String ID of a subscription invoice
A subscription invoice bill (default view)
end
items
month
start
tax
Double Tax amount format: double
total
Double Total amount format: double
total_with_tax
Double Total with tax amount format: double
year
A subscription invoice bill item (default view)
amount
chats_used (optional)
end (optional)
order (optional)
start
subscription_invoice collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
A subscription invoice item (default view)
amount
chats_used (optional)
end (optional)
id (optional)
order (optional)
start
A subscription order (default view)
chat_package
created_at
Date Date of creation format: date-time
end (optional)
Date Optional date and time of the subscription end format: date-time
id
String ID of a subscription order
is_accepted
Boolean Flag whether the order is accepted
is_custom
Boolean Flag whether it is custom subscription order
is_free
Boolean Flag whether the order is free
needs_payment
Boolean Flag whether the order needs payment
organisation (optional)
period
plan
start
Date Date and time of the subscription start format: date-time
status
tax
Double Bill tax format: double
total
Double Order total format: double
total_with_tax
Double Bill total including tax format: double
updated_at (optional)
Date Date of update format: date-time
vouchers (optional)
A subscription order (reference view)
chat_package
end (optional)
Date Optional date and time of the subscription end format: date-time
id
String ID of a subscription order
needs_payment
Boolean Flag whether the order needs payment
organisation (optional)
period
start
Date Date and time of the subscription start format: date-time
status
vouchers (optional)
subscription_order collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
A subscription plan (default view)
bot_questions (optional)
Long Maximum allowed bot questions for this plan format: int64
bots (optional)
Long Maximum allowed bots for this plan format: int64
chat_packages (optional)
currency
description
features (optional)
id
String ID of a subscription plan
is_free
Boolean Flag whether subscription plan is a free plan
is_manual
Boolean Flag whether subscription plan can only be assigned manually (by admins)
name
old_price (optional)
Double Old price of a subscription plan format: double
price
Double Price of a subscription plan format: double
white_label
Boolean Flag whether subscription plan is white label
A subscription plan (reference view)
id
String ID of a subscription plan
subscription_plan collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
A subscription voucher (default view)
code
String Subscription voucher code
created_at
group
id
String ID of a subscription voucher group
redeemed_at (optional)
updated_at (optional)
subscription_voucher collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
A subscription voucher group (default view)
capacity
Long Voucher group capacity format: int64
chat_package
created_at
Date Date of creation format: date-time
end (optional)
Date Optional date and time of the voucher group effective end format: date-time
id
String ID of a subscription voucher group
name
String Subscription voucher group name
params (optional)
period
plan
redeemed
Long Voucher group redeemed count format: int64
start (optional)
Date Optional date and time of the voucher group effective start format: date-time
status
updated_at (optional)
Date Date of update format: date-time
A subscription voucher group (reference view)
id
String ID of a subscription voucher group
name
String Subscription voucher group name
status
subscription_voucher_group collection (default view)
count
Long Total number of items in a collection format: int64
current_page
Long Current page number format: int64
has_next_page
has_prev_page
Boolean Collection has previous page
items
page_count
Long Number of pages in a collection format: int64
page_size
Long Page size format: int64
Translation
cs_cz (optional)
de_de (optional)
en_us (optional)
es_es (optional)
fr_fr (optional)
it_it (optional)
nl_nl (optional)
pt_br (optional)
ru_ru (optional)
uk_ua (optional)
Bot trigger condition fields
description (optional)
id
0
10
11
1
2
3
4
5
6
7
8
9
12
13
14
15
name (optional)
value
ip
country
city
pageHostName
pagePath
pageURL
referrer
dayOfWeek
time
deviceType
day
month
isReturning
visitCount
state
continent
Bot trigger condition operator
description (optional)
id
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
name (optional)
value
=
!=
startsWith
notStartsWith
endsWith
notEndsWith
matchesRegEx
notMatchesRegEx
iMatchesRegEx
notIMatchesRegEx
<
>
<=
>=
in
notIn
Twitter events verify response (default view)
Usage item
amount
Long Current amount format: int64
quota
Long Allowed quota format: int64
status
Visitor device
description (optional)
id
0
1
2
3
name (optional)
value
mobile
desktop
tablet
other
Error response media type (default view)
code (optional)
String an application-specific error code, expressed as a string value.
detail (optional)
String a human-readable explanation specific to this occurrence of the problem.
id (optional)
String a unique identifier for this particular occurrence of the problem.
meta (optional)
Object a meta object containing non-standard meta-information about the error.
status (optional)
String the HTTP status code applicable to this problem, expressed as a string value.