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

# Act on a package

> Applies one of: send (DRAFT to IN_PROGRESS and starts signing; requires canSendPackages and every required custom field filled, else 422), void or on_hold (require canVoidPackages), or transfer ownership to `newOwnerId` (the current owner or canTransferPackages).



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/packages/{packageId}
openapi: 3.0.3
info:
  title: FlowSign API
  version: 1.0.0
  description: >-
    Public v1 API for FlowSign. Every endpoint is authenticated with a Bearer
    API key (prefix `fsk_`). Errors use `{ error, details? }`; success responses
    wrap payload data as `{ data }`.


    An organisation is divided into workspaces. A key belongs to the
    organisation and acts in one workspace per request: pass `X-Workspace-Id`
    (see `GET /api/v1/workspaces`) or omit it to act in the default workspace.
    Packages, templates, contacts and members are scoped to the workspace the
    call acts in.
servers:
  - url: https://my.flowsign.app
    description: Production
security:
  - ApiKey: []
paths:
  /api/v1/packages/{packageId}:
    patch:
      tags:
        - Packages
      summary: Act on a package
      description: >-
        Applies one of: send (DRAFT to IN_PROGRESS and starts signing; requires
        canSendPackages and every required custom field filled, else 422), void
        or on_hold (require canVoidPackages), or transfer ownership to
        `newOwnerId` (the current owner or canTransferPackages).
      operationId: patchPackagesByPackageId
      parameters:
        - schema:
            type: string
          required: true
          name: packageId
          in: path
        - schema:
            type: string
            description: >-
              The workspace to act in, from `GET /api/v1/workspaces`. Omit to
              act in the organisation's default workspace. A workspace the key's
              user cannot act in is treated as omitted.
          required: false
          name: x-workspace-id
          in: header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - send
                  required:
                    - action
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - void
                  required:
                    - action
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - on_hold
                  required:
                    - action
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - transfer
                    newOwnerId:
                      type: string
                      minLength: 1
                  required:
                    - action
                    - newOwnerId
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                          status:
                            type: string
                            enum:
                              - DRAFT
                              - SCHEDULED
                              - IN_PROGRESS
                              - COMPLETED
                              - DECLINED
                              - ON_HOLD
                              - VOID
                        required:
                          - id
                          - status
                      - type: object
                        properties:
                          id:
                            type: string
                          newOwnerId:
                            type: string
                        required:
                          - id
                          - newOwnerId
                required:
                  - data
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Caller's plan does not include this feature (publicApi / webhooks)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API key present but caller lacks the required permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Request failed schema validation; details keyed by field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded; see `Retry-After`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        details:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - error
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: fsk_*

````