Skip to main content
POST
Create error code

Authorizations

cc-key
string
header
required

API key-based authentication. Provide your CloudCruise API key in the cc-key header.

Headers

cc-key
string

CloudCruise API key for authentication

Body

application/json
error_code
string
required

Name of the error code. Must not be blank; leading and trailing whitespace is trimmed.

Maximum string length: 100
Example:

"CLAIM_NOT_FOUND"

description
string
required

Short description of the error

Example:

"The claim number was not found in the payer portal"

enriched_description
string

Longer description used to classify errors against this code

error_action
enum<string>

What CloudCruise does when a run fails with this code

Available options:
alert,
cancel,
pause,
retry,
input_required
retries
integer

Number of retries when error_action is retry

Required range: x >= 0
retry_after
integer

Seconds to wait between retries when error_action is retry

Required range: x >= 0

Response

The created error code, or the existing one with the same name

created
boolean
required

true if a new code was created, false if an existing code with the same name was returned

id
string<uuid>

Unique identifier. Use this value in a node's error-code parameter.

error_code
string

Name of the error code, e.g. CLAIM_NOT_FOUND

description
string | null

Short description of the error

enriched_description
string | null

Longer description used to classify errors against this code

error_action
enum<string> | null

What CloudCruise does when a run fails with this code

Available options:
alert,
cancel,
pause,
retry,
input_required
retries
integer | null

Number of retries when error_action is retry

retry_after
integer | null

Seconds to wait between retries when error_action is retry

workspace_id
string<uuid>

ID of the workspace this error code belongs to

created_at
string<date-time>

Timestamp when the error code was created