Skip to main content
POST
Submit web form data

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Path Parameters

id
string
required

Id of the Web Form which will be used to create a conversation.

Body

application/json
from
string
required

Sender of the submission.

Minimum string length: 1
content
string
required

Web form submission body content.

Minimum string length: 1
subject
string

Submission subject.

cc
string[]

List of web form submission carbon copy recipients.

List of web form submission carbon copy recipients.

attachmentIds
string[]

Web form submission attachment Ids.

Web form submission attachment Ids.

Response

OK

conversationId
string