Skip to main content
POST
Create a redline request

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials access token, passed as a Bearer token in the Authorization header.

Body

application/json
templateId
string
required

The ID of the template to create a redline request for.

Example:

"abc123xyz"

members
object[]
required

Array of members participating in the redline request.

Minimum array length: 1
Example:
testMode
boolean

Optional flag to enable test mode for the redline request. Defaults to false.

Example:

false

metadata
object

Optional metadata for the redline request.

Response

Redline request created successfully.

redlineRequestId
string

The unique identifier of the created redline request.

Example:

"abc123xyz"

templateId
string

The ID of the new template created for the redline request.

Example:

"def456uvw"