Accounts2

AI Analysis2

Bank Accounts1

Batches4

Cases8

Custom Lists8

Diagnostics1

Documents9

Entities10

Entity Feedback2

Entity Groups1

Evaluations5

Events3

Groups3

Investigations24

Journeys20

Lists6

OAuth2

Portfolio Evaluations2

Published Attributes6

Reviews6

Transactions2

Reviews

Create a Review for a Group.

Changed on Nov 3, 2026

<Callout type="warning" title="Deprecated Warning"> This endpoint is deprecated in favor of Journeys. </Callout>

post/groups/{group_token}/reviews

Request

Base URL
https://sandbox.alloy.co/v1
Auth
- OAuth 2
  Client credentials
  Token URL/oauth/bearer
- or HTTP basic
TypeScript
https://skmtc.dev/alloy/apis/alloy-api/docs/groups/:group_token/reviews/post.ts
A function with typed inputs. Its response is checked against the schema.

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.

Headers

Authorizationstring

Basic authorization header per the OAuth Client Authorization Header standard.

The format is Basic <auth_string>, where <auth_string> is the base64 encoding of the string token:secret (check Authentication Guide for details).

alloy-workflow-tokenstring

If you have migrated to the new API Key Settings page and are using account-level API keys for authentication, this header is required to specify the workflow for the evaluation unless it is provided in the request body.

If you have not migrated yet, this header is optional, as the workflow will be determined by the Authorization header using workflow_token.

Request body

applicationTokenstring

Assign workflow of the review. Optional if it has been provided in the header.

reasonsstring[] required

Array of reasons for this Review and the Review's Outcome. Value should should equal a Review Reason that's defined in your Alloy account settings.

outcomestring required

Outcome of the Review. Value should equal an Outcome that's defined in your Alloy account settings.

Response

Review Object.

review_tokenstring

Unique ID for the Review.

entity_tokenstring

Unique ID for the Entity associated with the Review. Depending on how the Review is created, this value can also point to a Group Token.

group_tokenstring

Unique ID for the Group (of Entities) associated with the Review.

application_tokenstring

Unique ID for the Application (Workflow) associated with the Review. If Review is created via the API, this is determined by the authentication tokens used.

outcomestring

Outcome of the Review. Value should equal an Outcome that's defined in your Alloy account settings.

application_namestring

Name of the Application (Workflow) associated with this Review. If Review is created via the API, this is determined by the authentication tokens used.

reviewerstring

Email of the Agent that created the Review.

timestampnumber

Unix timestamp when the Review was created.

reasonsstring[]