Skip to main content
POST
/
app
/
workflows
/
approval_requests
import cobo_waas2
from cobo_waas2.models.create_approval_request201_response import (
    CreateApprovalRequest201Response,
)
from cobo_waas2.models.request_approval import RequestApproval
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.AppWorkflowsApi(api_client)
    request_approval = cobo_waas2.RequestApproval(
        operation_id="f47ac10b-58cc-4372-a567-0e02b2c3d479",
        request_id="f47ac10b-58cc-4372-a567-0e02b2c3d479",
        initiator_email="[email protected]",
        fields=[
            cobo_waas2.AppWorkflowField(field="amount", value_type="INT", value="11.23")
        ],
        guard_template="example_string",
    )

    try:
        # Request workflow approval
        api_response = api_instance.create_approval_request(
            request_approval=request_approval
        )
        print("The response of AppWorkflowsApi->create_approval_request:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling AppWorkflowsApi->create_approval_request: %s\n" % e
        )


{
  "approval_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
import cobo_waas2
from cobo_waas2.models.create_approval_request201_response import (
    CreateApprovalRequest201Response,
)
from cobo_waas2.models.request_approval import RequestApproval
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.AppWorkflowsApi(api_client)
    request_approval = cobo_waas2.RequestApproval(
        operation_id="f47ac10b-58cc-4372-a567-0e02b2c3d479",
        request_id="f47ac10b-58cc-4372-a567-0e02b2c3d479",
        initiator_email="[email protected]",
        fields=[
            cobo_waas2.AppWorkflowField(field="amount", value_type="INT", value="11.23")
        ],
        guard_template="example_string",
    )

    try:
        # Request workflow approval
        api_response = api_instance.create_approval_request(
            request_approval=request_approval
        )
        print("The response of AppWorkflowsApi->create_approval_request:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling AppWorkflowsApi->create_approval_request: %s\n" % e
        )

Authorizations

​
BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body to request workflow approval.

The information about a approval request.

​
operation_id
string
required

The unique ID of the approval workflow.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
request_id
string
required

An identifier provided by you to track this request.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
initiator_email
string
required

The email of the user who requested the approval.

Example:

"[email protected]"

​
fields
object[]
required
​
guard_template
string
required

The template of a Cobo Guard message. Please connect [email protected] to get the template content.

Response

The request workflow approval was successful.

​
approval_id
string<uuid>
required

The system-generated unique ID of the approval request. You can use this ID to query the approval request status or revoke the request.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"