Update a form

patch

https://api.wingspan.app/v3/compliance/forms/{formId}

Partial update via JSON Merge Patch (RFC 7396). Only a directly created form in Draft can be edited. A form managed by an automation (isManaged: true — source.type in {TaxFiling, ComplianceEntity}), or one that has already become Effective, returns 409 Conflict; managed forms change only through their source automation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

formId

string

required

Unique identifier of the form

Body Params

Partial update of a directly created draft form. A managed or already-issued form returns 409 Conflict. PATCH semantics: omitted fields are left unchanged; explicit null clears nullable fields.

externalId

string | null

recipient

object

A party named on the form (recipient or issuer).

payer

object

A party named on the form (recipient or issuer).

formData

Type-specific form data. The nested type discriminator must match the parent Form.type, which remains the canonical form kind for filtering and lifecycle decisions. The full schema for each type is published by the FormSchema registry.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated form

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

501This operation is not yet available