> ## Documentation Index > Fetch the complete documentation index at: https://widgetic.com/llms.txt > Use this file to discover all available pages before exploring further. # Make a widget a preset, or replace a preset > Offers one of the partner's own widgets as a preset under `key`. If the partner already has a preset under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole preset: 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 (`rating`, `quiz-3`). The widget must belong to the partner's account; a widget that does not exist and one that belongs to somebody else are refused in the same way (404 `PRESET_WIDGET_NOT_FOUND`). A widget is a preset under at most one key (409 `PRESET_WIDGET_ALREADY_USED`; `details.key` says which), and an account can have at most 100 presets (409 `PRESET_LIMIT_REACHED`). Later changes to the widget reach new copies and new compositions; copies made earlier are not touched. Deleting the widget removes its preset. ## OpenAPI ````yaml /openapi/widgetic-api-public.json put /partners/{partnerId}/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}/presets/{key}: put: tags: - Partners summary: Make a widget a preset, or replace a preset description: > Offers one of the partner's own widgets as a preset under `key`. If the partner already has a preset under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole preset: 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 (`rating`, `quiz-3`). The widget must belong to the partner's account; a widget that does not exist and one that belongs to somebody else are refused in the same way (404 `PRESET_WIDGET_NOT_FOUND`). A widget is a preset under at most one key (409 `PRESET_WIDGET_ALREADY_USED`; `details.key` says which), and an account can have at most 100 presets (409 `PRESET_LIMIT_REACHED`). Later changes to the widget reach new copies and new compositions; copies made earlier are not touched. Deleting the widget removes its preset. operationId: setPartnerPreset parameters: - in: path name: partnerId required: true schema: type: string format: uuid description: The partner whose preset 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 uses for the preset requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetPartnerPresetRequest' responses: '200': description: The preset as saved content: application/json: schema: $ref: '#/components/schemas/PartnerPresetResponse' '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, or the widget is not one of yours (PRESET_WIDGET_NOT_FOUND) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The widget is already a preset under another key (PRESET_WIDGET_ALREADY_USED), or the account has 100 presets (PRESET_LIMIT_REACHED) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - apiKeyAuth: [] components: schemas: SetPartnerPresetRequest: type: object additionalProperties: false required: - widgetId properties: widgetId: type: string format: uuid description: >- One of the partner's own widgets. A widget is a preset under at most one key. title: type: string nullable: true minLength: 1 maxLength: 120 description: What your picker shows. Leave it out to show the widget's own name. description: type: string nullable: true maxLength: 500 position: type: integer minimum: 0 maximum: 10000 default: 0 description: >- Where the preset sits in the list. Smallest first; presets with the same position are ordered by key. example: widgetId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 title: Example title description: Example description position: 42 PartnerPresetResponse: type: object required: - success - data properties: success: type: boolean description: Always `true` on a success. example: true data: $ref: '#/components/schemas/PartnerPreset' meta: $ref: '#/components/schemas/ResponseMeta' 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' PartnerPreset: type: object description: > A widget the partner offers its managed users as a starting point, under a key the partner's code names. It belongs to the partner's account, so every managed user of the partner sees the same list. required: - key - widgetId - title - description - position - widgetName - thumbnailUrl - createdAt - updatedAt properties: key: type: string description: The name the partner's code uses for the preset example: rating widgetId: type: string format: uuid description: >- The partner's widget. Use it to make a composition (`createComposition` with this `widgetId`). title: type: string nullable: true description: What the partner's picker shows. Null means show `widgetName`. example: Star rating description: type: string nullable: true position: type: integer description: The list is ordered by this, smallest first, then by key widgetName: type: string description: The widget's own name thumbnailUrl: type: string nullable: true description: The widget's thumbnail, when it has one createdAt: type: string format: date-time updatedAt: type: string format: date-time example: key: rating widgetId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 title: Star rating description: Example description position: 42 widgetName: Example widgetName thumbnailUrl: Example thumbnailUrl 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). 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.