Usage Info

The Workflow represents a structured process or series of activities performed using the Subject Record data. This method allows the update of the workflow details when it has status CREATED and it's type BUSINESS_APPLICATION.

Use this method to update Business Application details of a workflow before it's started.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The workflow id of the workflow record to be updated.
workflow	object	Yes	The workflow parameter defined in the tables below.

Workflow Parameters

Parameter	Type	Required	Description
details	object	Depends	One of the Workflow details objects. The table below maps the Workflow Type to the Workflow Details.

Workflow Type to Details Mapping

Workflow Type	Workflow Details
BUSINESS_APPLICATION	Business Application Details

Business Application Details Parameters

Parameter	Type	Required	Description
applying_user	object	No	The object containing information about the applying user. This information is used for identification, communication, and authentication.
pricing_model_id	string	No	The ID of the pricing model to use. Different pricing models allow a single account to allow different rules for determining pricing. Pricing models are created during account setup and are optional.
equipment_collection_id	string	No	The ID of the equipment collection catalog to use. Equipment collections are created during account setup and is optional.
referrer_value	string	No	The customer provided value to identify how application was referred, such as a marketplace, website, or sales person. This field is limited to 100 characters.

Applying User Parameters

Parameter	Type	Required	Description
email	string	No	The email address of the applying user. The email must be a validly formatted email address. NOTE: Depending upon the account configuration, this email address may need to be unique for all Business-Application-type Workflows for the given `account_id` used on creation.
first_name	string	No	The first name of the applying user.
last_name	string	No	The last name of the applying user.

Examples

Updating a Business Application Workflow

{
  "account_id": "sb_j8gh53b",
  "workflow": {
    "type": "BUSINESS_APPLICATION",
    "subject_record_id": "sr_163Gh1ONk6BCHF9iYVDHcv",
    "details": {
      "business_application_details": {
        "applying_user": {
          "email": "[email protected]",
          "first_name": "Joe",
          "last_name": "Fette"
        },
        "referrer_value": "UAYACG123",
        "equipment_collection_id": "mock_id",
        "pricing_model_id": "mock_id"
      }
    }
  }
}

Response

Data

An empty data object is returned when the completion is successful.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {}
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `pricing_model_id`, or `equipment_selection_id` provided does not exist.
ACCOUNT_CONFIGURATION_VIOLATION	400	Account configuration rule violations are described below.

Account Configuration Violations

When a ACCOUNT_CONFIGURATION_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Workflow	DUPLICATE_EMAIL	The email address provided for the applying user is already in use by another Business-Application-type Workflow for the same account. This error code is only returned when the account does not support multiple applications per email.