---
title: "Create a form batch"
method: POST
path: "/form_batches"
tags: ["Form Batches"]
---

# Create a form batch

`POST /form_batches`

## Request body

- object
  - `owner_id` string, required
  - `form_type` 'rl1' | 'roe' | 't4' | 't4a' | 'td1' | 'td1ab' | 'td1bc' | 'td1mb' | 'td1nb' | 'td1nl' | 'td1ns' | 'td1nt' | 'td1nu' | 'td1on' | 'td1pe' | 'td1sk' | 'td1x' | 'td1yt' | 'tp_1015_3_v' | 'tp_1015_r_13_v', required — The type of Forms in this batch (e.g. T4, RL-1). Must be a form type that supports form batches. Not all form types support batches.
  - `effective_date` string, date — The effective date used to determine the form variant for all Forms in this batch. Determines the form variant. Defaults to January 1 of the current year if not provided.
  - `form_stage` 'amendment' | 'cancellation' | 'original' — The lifecycle stage of the Forms in this batch: original, amendment, or cancellation. Defaults to `original` if not provided.
  - `contact_name` string, required — The name of the contact person responsible for this submission.
  - `contact_email` string, required — The email address of the contact person.
  - `contact_area_code` string, required — The 3-digit area code of the contact's phone number.
  - `contact_phone_number` string, required — The 7-digit phone number of the contact.
  - `contact_extension` string, nullable — The optional extension for the contact's phone number.
  - `note` string, nullable — An optional note for this form batch.

## Response `201`

Created

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"form_batch"`).
  - `data` FormBatch
    - `owner` object — The owner of this form batch. Currently always a Business Entity.
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"business_entity"`).
    - `form_type` 'rl1' | 'roe' | 't4' | 't4a' | 'td1' | 'td1ab' | 'td1bc' | 'td1mb' | 'td1nb' | 'td1nl' | 'td1ns' | 'td1nt' | 'td1nu' | 'td1on' | 'td1pe' | 'td1sk' | 'td1x' | 'td1yt' | 'tp_1015_3_v' | 'tp_1015_r_13_v' — The type of Forms in this batch (e.g. T4, RL-1).
    - `form_stage` 'amendment' | 'cancellation' | 'original' — The lifecycle stage of the Forms in this batch: original, amendment, or cancellation.
    - `effective_date` string, date — The effective date used to determine the form variant for all Forms in this batch.
    - `status` 'done' | 'draft' | 'processing' | 'submitted' — The submission status of this batch.
    - `contact_name` string — The name of the contact person responsible for this submission.
    - `contact_email` string — The email address of the contact person.
    - `contact_area_code` string — The 3-digit area code of the contact's phone number.
    - `contact_phone_number` string — The 7-digit phone number of the contact.
    - `contact_extension` string, nullable — The optional extension for the contact's phone number.
    - `note` string, nullable — An optional note for this form batch.
    - `metadata` object, nullable — Form-type-specific metadata for this batch. Structure varies by form type.
      - `counts` object, nullable
        - `total` number, nullable
        - `valid` number, nullable
        - `invalid` number, nullable
        - `draft` number, nullable
        - `approved` number, nullable
        - `processing` number, nullable
        - `submitted` number, nullable
        - `done` number, nullable
        - `rejected` number, nullable
      - `flags` object, nullable
        - `is_submittable` boolean
      - `timestamps` object, nullable
        - `submitted_at` string, dateTime, nullable
        - `completed_at` string, dateTime, nullable
      - `identifiers` object, nullable
        - `confirmation_number` string, nullable
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/a0c7a815860f/schema)