v4

OpenAPI 3.0.02026-07-314441026.8 MB
Form Batches

Update a form batch

put/form_batches/{form_batch}

Path parameters

form_batchstring required

Request body

owner_idstring

Read-only after creation.

owner_typestring
form_typestring

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

Read-only after creation.

form_stagestring

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

Read-only after creation.

effective_datestring

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

Read-only after creation.

statusstring

The submission status of this batch.

Read-only after creation.

contact_namestring

The name of the contact person responsible for this submission.

contact_emailstring

The email address of the contact person.

contact_area_codestring

The 3-digit area code of the contact's phone number.

contact_phone_numberstring

The 7-digit phone number of the contact.

contact_extensionstring nullable

The optional extension for the contact's phone number.

notestring nullable

An optional note for this form batch.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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