Executes multiple requests, grouped into “chains”, in a single call. The API Client (Client) can use multiple chains and specify sub-requests within each chain to run sequentially or in parallel. However the chains, themselves, will only run sequentially.
Clients can access a previous response’s value by using the format: $[previous request's uid]:[key path]
. Clients can use this in the value fields of:
requests[].body
requests[].path_params
requests[].query_params
The request’s path requests[].path
has an extra step to access a previous response’s value. In the request’s path, the Client will first refer to a key in the requests[].path_params
field using the format: {[path_params key name]}
. From there requests[].path_params
can use the pattern described in Accessing a previous response’s value to obtain a previous response’s value.
The initial security headers will be passed to all requests.
Scopes are not required for this endpoint. However, the API key must contain the appropriate scopes required by the individual requests to execute.
For FAQs and performance improvement details, visit Optimizing Performance with Request Chaining.