academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Request-form-profile-comments → Creates a request form profile comment object.

AI-generated

Summary

Creates a request form profile comment by sending the supplied comment data and its related request form profile to the academyFIVE API.

Inputs

  • data.type (required) — Comment object type.
  • data.attributes.text (required) — Comment text.
  • data.attributes.public — Whether the comment is public; defaults to false.
  • data.attributes.reminder — Whether the comment is a reminder; defaults to false.
  • data.attributes.commentFileJsonWebToken — JWT for a comment file, if applicable.
  • data.relationships.requestFormProfile.data.type (required) — Related request form profile object type.
  • data.relationships.requestFormProfile.data.id (required) — ID of the request form profile to associate with the comment.

Output shape

A list of JSON items returned by the API, with each item paired to its input item.

If the API response is an array, its entries become separate output items. With Continue On Fail enabled, a failed request produces an item containing an error message.

Examples

Example 1: Add a private comment to a request form profile.

Provide the comment type, text, and the related profile's type and ID; leave public unset or false.

Links

Discussion