Sign in

v1

latestOpenAPI 3.0.02026-07-241220330.3 KB
Reviews

Add a Note to a Review Group.

<Callout type="warning" title="Deprecated Warning"> This endpoint is deprecated in favor of Journeys. </Callout>
post/groups/{group_token}/reviews/{review_token}/notes

Path parameters

group_tokenstring required

Unique ID for the Group associated with the Review. When reviewing a Group via this endpoint, the Group Token is set in group_token in the response, and the entity_token property is not returned.

review_tokenstring required

Unique ID for the Review.

Request body

notestring required

Content to include in the body of the note.

note_author_agent_emailstring required

Valid email of agent with Alloy account access, associated with creation of the note.

Response

Review Group Note Response.

review_tokenstring

Unique ID for the Review.

notestring

Content to include in the body of the note.

note_author_agent_emailstring

Valid email of agent with Alloy account access, associated with creation of the note.

created_atnumber

Unix timestamp when the note was created.

updated_atnumber

Unix timestamp when the note was last updated.

Example response

{
  "review_token": "R-c78PhQHJOeJhPfzYh5MX",
  "note": "this is a note",
  "note_author_agent_email": "this+agent@alloy.co",
  "created_at": 1634059958368,
  "updated_at": 1634059958368
}