REST API - Defining a Reply in the Request Body

Updated by Stefenie Stockbridge

To add or update a reply to a comment, you must define your reply in the request body.

Method

The reply must be submitted using the HTTP POST method or HTTP PATCH method depending on the type of request you are submitting.

Parameters

The following parameters must be specified within the Reply element:

  • Description : Write your reply in this element. Plain text formatting and HTML are supported.

Examples

ReplyToComment Example

Here is an example of a request body in XML format:

<?xml version="1.0" ?>
<Reply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.blueprintsys.com/blueprint/api/v1">
<Description>&lt;html&gt;&lt;head&gt;&lt;/head&gt;&lt;body&gt;&lt;div&gt;&lt;p&gt;&lt;span&gt;&lt;span&gt;Reply&lt;/span&gt;&lt;/span&gt;&lt;/p&gt;&lt;/div&gt;&lt;/body&gt;&lt;/html&gt;</Description>
</Reply>

Here is an example of a request body in JSON format:

{
  "Description": "<html><head></head><body><div><p><span><span>Reply</span></span></p></div></body></html>"
}

How did we do?