---
title: "Configure an AS2/SFTP environment or request go-live handoff."
method: PATCH
path: "/v1/connections/{connectionId}"
tags: ["Connections"]
---

# Configure an AS2/SFTP environment or request go-live handoff.

`PATCH /v1/connections/{connectionId}`

## Request

- Base URL: `https://signaledi.com/api`
- URL: `https://signaledi.com/api/v1/connections/{connectionId}`
- Auth: HTTP bearer

## Path parameters

- `connectionId` string, required

## Request body

- ConnectionMutationRequest
  - `action` 'configure_environment' | 'request_go_live', required
  - `environment` 'LAB' | 'CERTIFICATION' | 'PRODUCTION'
  - `gatewayId` string
  - `x12Envelope` object
  - `requirementVersion` string
  - `candidateFingerprint` string: Required for request_go_live; copy the current fingerprint from the workspace response.

## Response `200`

Updated sanitized workspace.

- ConnectionMutationResult
  - `ok` true, required
  - `workspace` object, required
  - `idempotentReplay` boolean, required

## Other responses

- `400`: Body failed validation (`code` VALIDATION_ERROR, NO_WORKSPACE), `candidateFingerprint` missing for request_go_live (CONNECTION_CANDIDATE_REQUIRED), or the Idempotency-Key is missing (IDEMPOTENCY_KEY_REQUIRED).
- `401`: Missing or invalid API key (`code` AUTH_UNAUTHORIZED).
- `403`: API key lacks the required `platform` scope (`code` PLATFORM_SCOPE_REQUIRED), its lane is invalid (API_KEY_ENVIRONMENT_INVALID), the workspace is not entitled to the platform API (PLATFORM_NOT_ENTITLED), or a supplied `workspaceId` does not match the authenticated workspace (FORBIDDEN).
- `404`: Resource not found, or the /v1 platform is disabled (`code` NOT_FOUND / PARTNER_NOT_FOUND / WORKSPACE_NOT_FOUND).
- `409`: The `Idempotency-Key` was already used with a different request body (`code` IDEMPOTENCY_CONFLICT). Reuse the key only to replay the identical request.
- `429`: Rate limit exceeded (`code` RATE_LIMITED).
- `500`: Unexpected server error (`code` e.g. PARSE_FAILED, VALIDATE_FAILED, OUTBOUND_FAILED, INBOUND_FAILED, BATCH_FAILED, TRANSACTIONS_FAILED, DOCUMENT_RECEIPT_FAILED, DOCUMENT_PAYLOAD_FAILED). Sanitized bodies carry an opaque `correlationId` to quote to support; internal error text is never echoed.

---

[API](https://skmtc.dev/signaledi/apis/signaledi-developer-api.md) · [All operations](https://skmtc.dev/signaledi/apis/signaledi-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signaledi/apis/signaledi-developer-api/revisions/9bc596644a10?raw)