POST/simulate/comment-added

Simulate Comment Added

Simulates a comment being added to an application and fires the comment.created webhook.

Blocked in production. Returns 400 when simulation is disabled.

Note: The comment text is sent in the Remark field (not Comment).

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Field	Type	Required	Possible values	Description
`Id`	string	Required	—	Application ID.
`Remark`	string	Required	—	The comment text to add to the application. Note: this field is named `Remark`, not `Comment`.

Example request

{
  "Id": "6a4763a25f39cb7aee21f0e3",
  "Remark": "Reviewed and escalated to compliance."
}

{
  "Id": "6a4763a25f39cb7aee21f0e3",
  "Remark": "Reviewed and escalated to compliance."
}

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	`CommentId` — the ID of the newly created comment.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CommentId": "6a478e4e7267551942867f7b"
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CommentId": "6a478e4e7267551942867f7b"
  }
}

Fires the `comment.created` webhook event. A 400 is returned if the application ID is not found or simulation is disabled.

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.