# Explicitly write a form definition or final submission batch to GitHub through the optional writeback app.

Requires commentary.forms.writeback, the forms.github_writeback license feature, a configured optional GitHub writeback app, an installed repository target, and a valid branch/path target. Submission 

Canonical: https://commentary.dev/docs/reference/api/write-form-artifact-to-git-hub

`POST /api/v1/forms/{formId}/destinations/writeback`

Requires commentary.forms.writeback, the forms.github_writeback license feature, a configured optional GitHub writeback app, an installed repository target, and a valid branch/path target. Submission writeback accepts submissionId or submissionIds, writes one canonical JSON result file per submission in one commit, overwrites existing result paths, can explicitly create target branches with target.createBranch and target.baseBranch, and can optionally open a pull request. Commentary storage remains available when writeback is unavailable.

## Access

Use a credential with `commentary.forms.writeback`.

Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. [Set up developer access](/docs/build/developer-access).

## Parameters

| Name | Location | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `formId` | path | string | Yes | Form id or reference id. |
| `X-Commentary-Workspace-Id` | header | string | No | Must match the credential workspace. This header cannot widen grant authority. |
| `X-Correlation-Id` | header | string | No |  |

## Request body

Required. Supported content types: `application/json`.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `targetType` | `"form_definition"` · `"submission"` | No |  |
| `submissionId` | string | No |  |
| `submissionIds` | array of string | No |  |
| `target` | object | No |  |
| `format` | `"json"` · `"yaml"` | No |  |
| `commitMessage` | string | No |  |
| `openPullRequest` | boolean | No |  |
| `pullRequestTitle` | string | No |  |
| `pullRequestBody` | string | No |  |

## Call the endpoint

Replace path placeholders and your credential. For body operations, create `request.json` using the required fields above; this command does not invent resource identifiers or consent.

```bash
curl --request POST \
  'https://commentary.dev/api/v1/forms/<formId>/destinations/writeback' \
  --header 'Authorization: Bearer <your-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json
```

## Responses

| Status | Meaning | Payload |
| --- | --- | --- |
| `202` | Successful response. | object |
| `400` | The request was invalid. | [ExternalError](/docs/reference/schemas/external-error) |
| `401` | Authentication is required. | [ExternalError](/docs/reference/schemas/external-error) |
| `403` | The token or session does not have permission for this resource. | [ExternalError](/docs/reference/schemas/external-error) |
| `404` | The resource was not found. | [ExternalError](/docs/reference/schemas/external-error) |
| `429` | The request was rate limited. | [ExternalError](/docs/reference/schemas/external-error) |

### Successful response fields

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ok` | `true` | No |  |
| `formId` | string | No |  |
| `submissionId` | string | No |  |
| `submissionIds` | array of string | No |  |
| `writeback` | object | No |  |

## Recover from errors

Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.

## Contract and related guidance

Operation ID: `writeFormArtifactToGitHub`. [Download the OpenAPI contract](/docs/reference/openapi.json) for complete constraints and code generation. [Browse endpoints](/docs/reference/api-operations).