Preview workspace push

Preview changes from this workspace into the other workspace along a direct fork edge. Requires Admin access to both workspaces. The plan lists workflows to create, replace, or archive; replacements overwrite target drafts with the source deployment. Proposed mappings are not saved. Dependent choices use source workflow, block, and field IDs. Billing-enabled deployments require Enterprise. Billing-disabled deployments require forking to be enabled by deployment feature configuration, such as FORKING_ENABLED. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:write.

POST/api/v2/workspaces/{workspaceId}/fork/push/preview

Authorization

X-API-Key<token>

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

In: header

Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.

curl -X POST "https://www.sim.ai/api/v2/workspaces/string/fork/push/preview" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "otherWorkspaceId": "string"  }'

const body = JSON.stringify({  "otherWorkspaceId": "string"})fetch("https://www.sim.ai/api/v2/workspaces/string/fork/push/preview", {  method: "POST",  headers: {    "Content-Type": "application/json",    "X-API-Key": "YOUR_API_KEY"  },  body})

package mainimport (  "fmt"  "net/http"  "io/ioutil"  "strings")func main() {  url := "https://www.sim.ai/api/v2/workspaces/string/fork/push/preview"  body := strings.NewReader(`{    "otherWorkspaceId": "string"  }`)  req, _ := http.NewRequest("POST", url, body)  req.Header.Add("X-API-Key", "YOUR_API_KEY")  req.Header.Add("Content-Type", "application/json")  res, _ := http.DefaultClient.Do(req)  defer res.Body.Close()  body, _ := ioutil.ReadAll(res.Body)  fmt.Println(res)  fmt.Println(string(body))}

import requestsurl = "https://www.sim.ai/api/v2/workspaces/string/fork/push/preview"body = """{  "otherWorkspaceId": "string"}"""response = requests.request("POST", url, data = body, headers = {  "Content-Type": "application/json",   "X-API-Key": "YOUR_API_KEY"})print(response.text)

import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{  "otherWorkspaceId": "string"}""");HttpClient client = HttpClient.newBuilder()  .connectTimeout(Duration.ofSeconds(10))  .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()  .uri(URI.create("https://www.sim.ai/api/v2/workspaces/string/fork/push/preview"))  .header("X-API-Key", "YOUR_API_KEY")  .header("Content-Type", "application/json")  .POST(body)  .build();try {  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());  System.out.println("Status code: " + response.statusCode());  System.out.println("Response body: " + response.body());} catch (Exception e) {  e.printStackTrace();}

using System;using System.Net.Http;using System.Text;var body = new StringContent("""{  "otherWorkspaceId": "string"}""", Encoding.UTF8, "application/json");var client = new HttpClient();client.DefaultRequestHeaders.Add("X-API-Key", "YOUR_API_KEY");var response = await client.PostAsync("https://www.sim.ai/api/v2/workspaces/string/fork/push/preview", body);var responseBody = await response.Content.ReadAsStringAsync();

{
  "data": {
    "previewFingerprint": "string",
    "sourceWorkspaceId": "string",
    "targetWorkspaceId": "string",
    "ready": true,
    "workflows": [
      {
        "action": "create",
        "sourceWorkflowId": "string",
        "targetWorkflowId": "string",
        "name": "string",
        "comparison": {
          "status": "available",
          "base": {
            "id": "string",
            "version": 1
          },
          "target": {
            "id": "string",
            "version": 1
          }
        }
      }
    ],
    "unresolvedBindings": [
      {
        "kind": "string",
        "sourceId": "string",
        "blockName": "string",
        "reason": "string"
      }
    ],
    "configuration": [
      {
        "sourceWorkflowId": "string",
        "sourceBlockId": "string",
        "subBlockKey": "string",
        "title": "string",
        "required": true,
        "currentValue": "string",
        "multiSelect": true,
        "selectorKey": "string",
        "discoveryWorkspaceId": "string",
        "context": {
          "property1": "string",
          "property2": "string"
        },
        "parentKind": "credential",
        "parentSourceId": "string",
        "parentContextKey": "string"
      }
    ],
    "excludedTargets": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "triggerSlots": [
      {
        "sourceWorkflowId": "string",
        "sourceBlockId": "string",
        "blockName": "string",
        "workflowName": "string",
        "ownPath": "string",
        "adoptablePaths": [
          "string"
        ],
        "defaultAdoptPath": "string"
      }
    ],
    "triggerUrlChanges": [
      {
        "workflowName": "string",
        "path": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The request conflicts with current resource state"
  }
}

{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}

{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}

Path parameters

workspaceId*string

Explicit current workspace scope.

Length1 <= length <= 128

Request body

application/json

Other workspace and proposed source-to-target sync choices.

TypeScript definitions

Use the request body type in TypeScript.

otherWorkspaceId*string

Workspace on the other side of the direct fork edge.

Length1 <= length <= 128

mappings?array<>

Proposed mapping entries addressed by resource type and sourceId. Preview does not save them; apply commits them with the sync.

Itemsitems <= 5000

dependentValues?array<>

Destination-specific choices addressed by source workflow ID, source block ID, and field key. Omission keeps saved overrides; an explicit empty array clears them.

Itemsitems <= 2000

copyResources?

Explicit source resources to copy before syncing the workflows.

dropReferences?array<>

Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped.

Itemsitems <= 2000

triggerMappings?array<>

Public trigger path choices from preview.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected.

Itemsitems <= 500

Response body

application/json

Sunbelt Computer Software

PL/B Language Development and Support

Preview workspace push

Authorization

Path parameters

Request body

Response body

Sunbelt Computer Software

PL/B Language Development and Support

Preview workspace push

Authorization

Path parameters

Request body

Response body

200

400

401

403

404

409

413

429

500

503