> ## Documentation Index
> Fetch the complete documentation index at: https://docs.formabledocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a redline request

> Creates a new redline request for a template with specified members. Each member must have an email, displayName, and role. The template must have a DOCX source file available for redlining.



## OpenAPI

````yaml /api-reference/openapi.json post /v0/redline-requests
openapi: 3.0.0
info:
  title: Formable API
  version: 1.0.0
  description: >-
    The Formable API lets you embed e-signature and document redlining workflows
    directly into your product. Create templates, send documents for signature,
    run collaborative redline negotiations, and retrieve completed documents.
servers:
  - url: https://formable-production.up.railway.app/api
    description: Production
  - url: http://localhost:4000/api
    description: Local
security:
  - bearerAuth: []
tags:
  - name: Templates
    description: Upload documents and generate editor URLs.
  - name: Signature Requests
    description: Send documents for e-signature and retrieve signed results.
  - name: Redlining
    description: Create and manage collaborative redline negotiations.
  - name: Billing
    description: Retrieve usage information.
  - name: Health
    description: Service health checks.
paths:
  /v0/redline-requests:
    post:
      tags:
        - Redlining
      summary: Create a redline request
      description: >-
        Creates a new redline request for a template with specified members.
        Each member must have an email, displayName, and role. The template must
        have a DOCX source file available for redlining.
      operationId: createRedlineRequest
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - templateId
                - members
              properties:
                templateId:
                  type: string
                  description: The ID of the template to create a redline request for.
                  example: abc123xyz
                members:
                  type: array
                  minItems: 1
                  description: Array of members participating in the redline request.
                  items:
                    $ref: '#/components/schemas/RedlineMemberInput'
                  example:
                    - email: disclosingparty@example.com
                      displayName: John Doe
                      role: DisclosingParty
                    - email: receivingparty@example.com
                      displayName: Jane Smith
                      role: ReceivingParty
                testMode:
                  type: boolean
                  description: >-
                    Optional flag to enable test mode for the redline request.
                    Defaults to false.
                  example: false
                metadata:
                  type: object
                  description: Optional metadata for the redline request.
                  properties:
                    subject:
                      type: string
                      description: The subject of the redline request.
                      example: Mutual NDA
      responses:
        '200':
          description: Redline request created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  redlineRequestId:
                    type: string
                    description: The unique identifier of the created redline request.
                    example: abc123xyz
                  templateId:
                    type: string
                    description: >-
                      The ID of the new template created for the redline
                      request.
                    example: def456uvw
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    RedlineMemberInput:
      type: object
      required:
        - email
        - displayName
        - role
      properties:
        email:
          type: string
          format: email
          description: Email address of the member.
          example: member@example.com
        displayName:
          type: string
          description: Display name of the member.
          example: John Doe
        role:
          $ref: '#/components/schemas/RedlineMemberRole'
    RedlineMemberRole:
      type: string
      enum:
        - DisclosingParty
        - ReceivingParty
        - DisclosingCounsel
        - ReceivingCounsel
      description: Role of the member in the redline request.
    Error:
      type: object
      properties:
        error:
          type: string
          description: A human-readable error message.
  responses:
    BadRequestError:
      description: Bad request - missing or invalid parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: templateId is required
    UnauthorizedError:
      description: Unauthorized - missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Auth token not valid
    ForbiddenError:
      description: Forbidden - the client is not authorized to perform this action.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Client not authorized to perform this action
    NotFoundError:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Resource not found for id abc123xyz
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Internal server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        OAuth 2.0 client credentials access token, passed as a Bearer token in
        the Authorization header.

````