---
title: "Execute via Proxy - PATCH"
method: PATCH
path: "/modules/{moduleId}/api"
tags: ["Modules"]
---

# Execute via Proxy - PATCH

`PATCH /modules/{moduleId}/api`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/modules/{moduleId}/api`
- Auth: OAuth 2
  - Client credentials
  - Password
  - Token URL: `https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token`
- TypeScript: <https://skmtc.dev/unqork/apis/unqork-customer-api/docs/modules/:moduleId/api/patch.ts> (a function with typed inputs; its response is checked against the schema)

API request layer for Server Side Execute to allow HTTPS calls to Execute a Module. The request format is flexible and may include files, text, xml or JSON Object. The path and query string are also flexible.
### Authorization Required:
  - Designer Administrator or Express Read

## Path parameters

- `moduleId` string, required

## Response `200`

Submission validated

- ModuleExecuteResponse
  - `id` string
  - `userId` string: Submission owner
  - `moduleId` string
  - `created` string, date-time
  - `modified` string, date-time
  - `deleted` string, date-time
  - `data` object: Raw output data
    - `rawData` object: Saved submission data
    - `resolved` object: Submission data resulting from execution
  - `metadata` object
  - `validationErrors` object[]
    - `id` string
    - `path` string
    - `label` string
    - `parent` string
    - `message` string
  - `invalidNavigationPanels` object[]
    - `key` string
    - `label` string

## Other responses

- `412`: Validation and/or execution error
- `2XX`: Custom HTTP status code if set by server side execution for API modules
- `4XX`: Custom HTTP status code if set by server side execution for API modules
- `5XX`: Custom HTTP status code if set by server side execution for API modules
- `default`: Error

---

[API](https://skmtc.dev/unqork/apis/unqork-customer-api.md) - [All operations](https://skmtc.dev/unqork/apis/unqork-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unqork/apis/unqork-customer-api/revisions/13dad4096373?raw)