Create an Outcome

Creates a new Outcome (Assignment) for the Tenant, tied to an Action.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Live keys only. This endpoint only works with a live_ API key. Any other key, including a test_ key, gets a 400 with this body, whatever you send:

{
  "type": "invalid_request_error",
  "errors": "Decision-tree authoring via API currently supports live mode tokens only."
}

Name rules

  • name can be up to 60 characters. It can only contain letters, numbers, spaces, hyphens and underscores. Leading and trailing spaces are removed.
  • name must be unique in your account. The check ignores case and spaces, so "VIP Approve" clashes with "vip approve" and "VIPApprove".

Outcome types

outcome_type is the id of the Action the outcome belongs to. The endpoint accepts these ids:

IdAction
1Approve
2Decline
3Review
4Accept
5Request Docs
6Identity Accept
7Identity Decline
8Credit Decline

Use 1, 2, 3 or 5 unless you have a specific reason not to. These are the Actions that List all Actions returns, and the only ids that List Outcomes by Action accepts. An outcome created with 4, 6, 7 or 8 does not show up in List Outcomes by Action.

Body Params
string
required

Name of the outcome. Up to 60 characters: letters, numbers, spaces, hyphens and underscores only. Must be unique in your account; the check ignores case and spaces. Leading and trailing spaces are removed.

int32
enum
required

Id of the Action this outcome belongs to: 1 Approve, 2 Decline, 3 Review, 4 Accept, 5 Request Docs, 6 Identity Accept, 7 Identity Decline, 8 Credit Decline. Use 1, 2, 3 or 5 unless you have a reason not to; List Outcomes by Action only accepts those ids.

string

Optional free-text description of the outcome.

boolean

Whether the outcome is active. Defaults to true.

Responses

401

The API key is not recognised or is inactive. The body is empty.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json