Skip to main content
POST
Create collaboration rule
See Human collaboration for the integration flow and trigger semantics. Retrieve the rule after saving to verify the conditions.

Authorizations

X-API-KEY
string
header
required

Production API Key. You can find it under My API in the ADP platform. Make sure the API Key is active and belongs to the production environment.

Path Parameters

tenant_name
string
default:laiye
required

Tenant name. Default: laiye.

Body

application/json
app_id
string
required

Application ID. Use the actual ID of a published standard custom extraction application owned by the current account.

Example:

"app_abc123"

rule_name
string
required

Rule name. The current service allows at most 50 characters and requires unique names across applications under the same account.

Required string length: 1 - 50
rule
object[]
required

Review trigger conditions, 1–100 items.

Required array length: 1 - 100 elements
rule_status
boolean
default:true

Whether the rule is enabled. Use false to disable it. The query endpoint may still return true; verify the effect with an extraction run.

rule_logic
enum<integer>
default:1

1=any condition matches (OR); 2=all conditions match (AND). Send only 1 or 2; other values may currently be accepted incorrectly.

Available options:
1,
2

Response

Business response. Check code and read business state back after writes.

code
string

Business result code. Success is success; failures may use server_error, http_server_error, or other strings. Always check this field, including for HTTP 200.

message
string
tips
string | null
data
object | null