NMnmi
Applications

Update an Application

Partially update an application. An application can be updated only when it is in draft status.

Required scope: applications:write

patch/applications/{application}

Request

  • Base URL
    https://sandbox.signup.nmi.com/api/v1
  • URL
    https://sandbox.signup.nmi.com/api/v1/applications/{application}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: applications:write

Path parameters

applicationstring required

The unique identifier of the application.

The ID of the application to update

Headers

Idempotency-Keystring

Provide a random key (for example, UUID) to make the request idempotent

Request body

Response

Application updated successfully

idstring required

The unique identifier of the application.

package_idstring required

The unique identifier of the package.

status'draft' | 'submitted' | 'approved' | 'rejected' | 'underwriter_requested_information' | 'requested_information_sent' | 'boarded' required
created_atstring date-time required

The date and time when the application was created.

updated_atstring date-time required

The date and time when the application was last updated.

Example response

{
  "package_id": "pkg_merrick_tsys",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.