Skip to main content
PUT
Update a form batch

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

form_batch
string
required

Body

application/json
owner_id
string

Read-only after creation.

owner_type
string
form_type
string

The type of Forms in this batch (e.g. T4, RL-1).

Read-only after creation.

form_stage
string

The lifecycle stage of the Forms in this batch: original, amendment, or cancellation.

Read-only after creation.

effective_date
string

The effective date used to determine the form variant for all Forms in this batch.

Read-only after creation.

status
string

The submission status of this batch.

Read-only after creation.

contact_name
string

The name of the contact person responsible for this submission.

Maximum string length: 255
contact_email
string

The email address of the contact person.

Maximum string length: 255
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 | null

The optional extension for the contact's phone number.

note
string | null

An optional note for this form batch.

Maximum string length: 65000

Response

200 - application/json

OK

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

The type of the object in Nmbr ("form_batch").

data
Form Batch · object