Reviews

Create a Review for an Entity

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

When an evaluation is assigned a “Manual Review” outcome, it goes to the Review Queue. While evaluations can be managed in the dashboard, it is also possible to change a status via API.

This endpoint can only be used for non-Journey evaluations. To review Journey or Entity applications, see the Journeys section.

A few things to note:

  • The agent whose email you include in the body of the request must be an agent on the account (View agents on the account via the main page of your account under "Agents").
  • The chosen outcome for the evaluation, as well as the reason given for that outcome in the body of the API request, must perfectly match those set up in Settings --> Review Reasons.
post/entities/{entity_token}/reviews

Request

Path parameters

entity_tokenstring required

Unique ID for the Entity or Group associated with the Review. If a Group Token is passed, the Group Token is set to the entity_token parameter in the response.

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

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[]

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.

Changes

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status