In Beta Phase
This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at firstname.lastname@example.org.
This API allows you to create a Conversation Group.
To create multiple Conversation Groups at the same time, see the Create Multiple Conversation Groups section.
Make a POST request to the following API:
|Optional||DEPRECATED. The JWT token you get from our authentication process.|
Using multiple Criteria
Given below is another sample request containing more than one
criteria. You can add upto 2 parameters per criteria, however, there are no restrictions on the number of criterions you can use. Here, we use
|Parameter||Data Type||Description||Required||Values Accepted|
|String||Name of the group.||Mandatory||String with no special characters allowed, except |
|String||Description to capture any additional details of the group and its purpose.||Optional||The maximum length of string allowed 512 characters.|
|String / RSQL format||Criteria in RSQL format that should be applied to group conversations under this group.||Mandatory||Valid RSQL string. For more information on how to write RSQL queries, click here.|
The newly created Group object is returned in the response body.
id returned in the Response is the Group ID which is a unique identifier of the Conversation Group created.
This API creates multiple Conversation Groups at the same time.
While working with multiple Conversation Groups, notice the use of plural
group used in singular Conversation Group operations.