Offer a workflow as a place to start, or replace what a key offers

curl --request PUT \
  --url https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Example title",
  "description": "Example description",
  "position": 42
}
'

import requests

url = "https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}"

payload = {
    "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Example title",
    "description": "Example description",
    "position": 42
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workflowId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    title: 'Example title',
    description: 'Example description',
    position: 42
  })
};

fetch('https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'workflowId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    'title' => 'Example title',
    'description' => 'Example description',
    'position' => 42
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}"

	payload := strings.NewReader("{\n  \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"title\": \"Example title\",\n  \"description\": \"Example description\",\n  \"position\": 42\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"title\": \"Example title\",\n  \"description\": \"Example description\",\n  \"position\": 42\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"title\": \"Example title\",\n  \"description\": \"Example description\",\n  \"position\": 42\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "key": "welcome-then-offer",
    "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Example title",
    "description": "Example description",
    "position": 42,
    "available": true,
    "unavailableReason": "Example unavailableReason",
    "workflowName": "Example workflowName",
    "blockCount": 42,
    "widgets": [
      "Example OfferedWorkflowPresetWidget"
    ],
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

Partners

Offer a workflow as a place to start, or replace what a key offers

Offers one of the partner account’s own published workflows to its managed users under key. If the partner already offers something under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole starting point: a title, description or position you leave out goes back to its default.

Keys are 1 to 64 characters: lowercase letters, digits, hyphens and underscores, the first a letter or a digit.

A workflow is offered once. What people get is the workflow’s live version as it is when they start, so publishing the workflow changes what new starts get; workflows people already started are never touched. The offer is refused, and error.details.reason says why, when the workflow:

is not the partner account’s own (a workflow of a team or of a customer, or of somebody else), or does not exist: 404, the same for both;
is archived (409 workflow_archived), or was never published (409 workflow_not_published);
shows no composition (422 workflow_empty), or a block shows a composition made for a customer or a team (422 composition_not_own);
chains more than 10 widgets (422 too_many_widgets), or a widget that the partner does not offer as a preset (422 widget_not_preset; error.details.widgets lists them, each with its id and name, so they can be offered first with setPartnerPreset);
is already offered under another key (409 workflow_already_offered; error.details.key says which), or the partner already offers 50 (409 too_many_presets).

The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator, who offers the partner’s workflow on its behalf.

PUT

partners

{partnerId}

workflow-presets

{key}

Offer a workflow as a place to start, or replace what a key offers

curl --request PUT \
  --url https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Example title",
  "description": "Example description",
  "position": 42
}
'

import requests

url = "https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}"

payload = {
    "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Example title",
    "description": "Example description",
    "position": 42
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workflowId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    title: 'Example title',
    description: 'Example description',
    position: 42
  })
};

fetch('https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'workflowId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    'title' => 'Example title',
    'description' => 'Example description',
    'position' => 42
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}"

	payload := strings.NewReader("{\n  \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"title\": \"Example title\",\n  \"description\": \"Example description\",\n  \"position\": 42\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"title\": \"Example title\",\n  \"description\": \"Example description\",\n  \"position\": 42\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.widgetic.com/v1/partners/{partnerId}/workflow-presets/{key}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflowId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"title\": \"Example title\",\n  \"description\": \"Example description\",\n  \"position\": 42\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "key": "welcome-then-offer",
    "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Example title",
    "description": "Example description",
    "position": 42,
    "available": true,
    "unavailableReason": "Example unavailableReason",
    "workflowName": "Example workflowName",
    "blockCount": 42,
    "widgets": [
      "Example OfferedWorkflowPresetWidget"
    ],
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partnerId

string<uuid>

required

The partner whose starting point to set

key

string

required

The name your code and the picker use for the starting point

Pattern: ^[a-z0-9][a-z0-9_-]{0,63}$

Body

application/json

workflowId

string<uuid>

required

One of your own published workflows.

title

string | null

What the picker shows. Leave it out to show the workflow's name.

Required string length: 1 - 120

description

string | null

Maximum string length: 500

position

integer

default:0

Where it sits in the list. Smallest first; the same position is ordered by key.

Required range: 0 <= x <= 10000

Response

The starting point as saved

success

boolean

required

Example:

true

data

object

required

A workflow you offer as a place to start, and what became of it. People start from it with their own copy of every widget it chains, a composition of their own on each copy, and a draft workflow wired like its live version.

Show child attributes

Example:

{
  "key": "welcome-then-offer",
  "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Example title",
  "description": "Example description",
  "position": 42,
  "available": true,
  "unavailableReason": "Example unavailableReason",
  "workflowName": "Example workflowName",
  "blockCount": 42,
  "widgets": ["Example OfferedWorkflowPresetWidget"],
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z"
}

API Reference

Public Embed

Workflows

Partners

Widgets

Users

Uploads

Tokens

Operations

Managed Users

Invoices

Entitlements

Credits

Compositions

Canvases

Brand Kit

Offer a workflow as a place to start, or replace what a key offers

Authorizations

Path Parameters

Body

Response