> ## Documentation Index > Fetch the complete documentation index at: https://widgetic.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi/widgetic-api-public.json put /partners/{partnerId}/workflow-presets/{key} openapi: 3.0.0 info: title: Widgetic API Gateway version: 1.0.0 description: API documentation for the Widgetic API Gateway license: name: Widgetic Integration License url: https://docs.widgetic.com/resources/license servers: - url: https://api.widgetic.com/v1 description: Production server variables: env: default: production description: Environment apiUrl: default: https://api.widgetic.com description: API URL apiVersion: default: /v1 description: API Version path prefix security: [] tags: [] paths: /partners/{partnerId}/workflow-presets/{key}: put: tags: - Partners summary: Offer a workflow as a place to start, or replace what a key offers description: > 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. operationId: setPartnerWorkflowPreset parameters: - in: path name: partnerId required: true schema: type: string format: uuid description: The partner whose starting point to set - in: path name: key required: true schema: type: string pattern: ^[a-z0-9][a-z0-9_-]{0,63}$ description: The name your code and the picker use for the starting point requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OfferWorkflowPresetRequest' responses: '200': description: The starting point as saved content: application/json: schema: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/OfferedWorkflowPreset' meta: $ref: '#/components/schemas/ResponseMeta' required: - success - data '400': description: The key or a field is malformed or not allowed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: The API key is missing or invalid content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The caller does not administer this partner content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- There is no such partner (reported to administrators only), or the workflow is not one of the partner account's own content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The workflow is archived, was never published, is already offered, the partner already offers as many as it may, or the partner has no administrator account (PARTNER_HAS_NO_ADMINISTRATOR) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: >- The workflow cannot be given away as it is (see the description for the reasons) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: Workflows cannot be used on this server right now content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - apiKeyAuth: [] components: schemas: OfferWorkflowPresetRequest: type: object additionalProperties: false required: - workflowId properties: workflowId: type: string format: uuid description: One of your own published workflows. title: type: string nullable: true minLength: 1 maxLength: 120 description: What the picker shows. Leave it out to show the workflow's name. description: type: string nullable: true maxLength: 500 position: type: integer minimum: 0 maximum: 10000 default: 0 description: >- Where it sits in the list. Smallest first; the same position is ordered by key. example: workflowId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 title: Example title description: Example description position: 42 OfferedWorkflowPreset: type: object description: > 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. required: - key - workflowId - title - description - position - available - unavailableReason - workflowName - blockCount - widgets - createdAt - updatedAt properties: key: type: string description: The name your code and the picker use for the starting point. example: welcome-then-offer workflowId: type: string format: uuid description: >- The workflow it is made from. What people get is its live version as it is when they start. title: type: string nullable: true description: What the picker shows. Null means show the workflow's name. description: type: string nullable: true position: type: integer description: The list is ordered by this, smallest first, then by key. available: type: boolean description: >- Whether people can start from it now. A starting point that is not available is not shown to anyone, and says why. unavailableReason: type: string nullable: true enum: - workflow_missing - workflow_not_own - workflow_archived - workflow_not_published - workflow_empty - composition_not_own - too_many_widgets - widget_not_preset description: > Why it is not available. `workflow_missing`: the workflow was deleted. `workflow_not_own`: it is no longer a workflow of your own. `workflow_archived`: unarchive it. `workflow_not_published`: it has no live version. `workflow_empty`: it shows no composition. `composition_not_own`: a block shows a composition made for a customer or a team. `too_many_widgets`: it chains more than 10 widgets. `widget_not_preset`: a widget it chains is no longer offered as a preset. workflowName: type: string nullable: true description: The workflow's name. Null when the workflow is gone. blockCount: type: integer nullable: true description: How many blocks its live version has. Null when it is not available. widgets: type: array description: >- The widgets it chains, once each, in the order they first appear. Empty when it is not available. items: $ref: '#/components/schemas/OfferedWorkflowPresetWidget' createdAt: type: string format: date-time updatedAt: type: string format: date-time 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' ResponseMeta: type: object description: >- Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat. additionalProperties: true properties: page: type: integer description: The page that was read, counting from 1. example: 1 size: type: integer description: How many items one page holds. example: 20 total: type: integer description: How many items the whole list has. example: 135 limit: type: integer description: The same as `size`. example: 20 offset: type: integer description: How many items come before this page. example: 0 hasNextPage: type: boolean example: true hasPreviousPage: type: boolean example: false nextCursor: type: string nullable: true description: >- Pass this as `cursor` to read the next page of a list that is read by cursor. `null` on the last page. warnings: type: array items: type: string description: >- Things the call did not do, though it succeeded (for example a table that could not be created just now). ErrorResponse: type: object required: - success - message - error additionalProperties: true properties: success: type: boolean description: Always `false` on a failure. example: false message: type: string description: The same text as `error.message`, for a caller that reads one line. error: $ref: '#/components/schemas/ErrorDetail' OfferedWorkflowPresetWidget: type: object description: A widget an offered starting point shows. required: - id - name - thumbnailUrl properties: id: type: string format: uuid description: Your own widget. name: type: string thumbnailUrl: type: string nullable: true example: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 name: Example name thumbnailUrl: Example thumbnailUrl ErrorDetail: type: object required: - code - message - timestamp properties: code: type: string description: Machine-readable error code. example: RESOURCE_NOT_FOUND message: type: string description: Human-readable explanation. example: Composition not found param: type: string description: The field that caused the error, when one did. example: name docUrl: type: string description: Where this error is explained. suggestedAction: type: string description: What to do about it. retryAfter: type: integer description: >- Seconds to wait before trying again (rate limits). The same number is in the `Retry-After` header. example: 60 details: type: object additionalProperties: true description: >- More about the error: the fields that failed, a limit that was reached. correlationId: type: string description: Quote this when you ask support about the call. example: req_123e4567-e89b-12d3-a456-426614174000 timestamp: type: string format: date-time example: '2026-10-15T10:00:00.000Z' securitySchemes: apiKeyAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.