Give a managed user a copy of one of your presets

Copies the preset key (see setPartnerPreset) onto a new canvas for one of your managed users, so their widget creator opens on a widget of their own that starts from yours. The copy is a draft widget in your account, filed under the managed user: getAllWidgets with managedUserId lists it, and no other managed user’s editor can reach it.

The copy carries the preset’s code, design and content schemas, and thumbnail, and starts from a fork of its code repository, so the user’s chat edits begin where yours left off. It does not carry the preset’s database or its compositions. It is not a preset itself, and changing or removing the preset afterwards never touches it.

To start a composition (the content and design editor) instead, you do not need a copy: call createComposition with the preset’s widgetId (from listPartnerPresets) and the managed user.

The Idempotency-Key header is required (400 without it). Send the same key when you retry, so one copy is made, not two. A copy that could not be made leaves nothing behind (503 PRESET_COPY_FAILED).

The managed user must be yours and active.

POST /managed-users/{id}/presets/{key}/copy

TypeScript SDK

TypeScript

import { randomUUID } from 'node:crypto';
import { Configuration, ManagedUsersApi } from '@widgetic/api-sdk-ts';

const managedUsersApi = new ManagedUsersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

// Give one of your users their own copy of the preset you registered as "rating":
// The call needs an idempotency key: reuse the same key if you retry this call.
const { data: copy } = await managedUsersApi.copyPresetForManagedUser({
  id: managedUserId,
  key: 'rating',
  idempotencyKey: randomUUID(),
});

// Open the widget creator on copy.canvasId and copy.widgetId.

201

{
  "success": true,
  "data": {
    "presetKey": "rating",
    "managedUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "canvasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "widgetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "widgetName": "Example widgetName",
    "warnings": []
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Headers

Idempotency-Key · string · required

Required: a call without it is refused with 400. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, - and _. Send the same key again when you retry (after a timeout, a dropped connection or a 5xx) and the call is carried out once: the retry gets the first answer back, marked X-Idempotency-Cached: true. The same key with a different body is refused with 422, and a retry that arrives while the first call is still running with 409 (see Retry-After).

Required string length: 8 - 50

Pattern: ^[a-zA-Z0-9_-]{8,50}$

Example:

"9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d"

Path Parameters

id · string<uuid> · required

The managed user to give the copy to (Widgetic's id for the user)

key · string · required

The key of the preset to copy

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

Body

application/json

name · string

Names the copy. Left out, the copy is named after the preset's title, or the widget's own name.

Required string length: 1 - 120

Response

201

application/json

The copy was made

success · boolean · required

Always true on a success.

Example:

true

data · object · required

Where the copy of a preset is. Open the widget creator on canvasId and widgetId.

Show child attributes

Example:

{
  "presetKey": "rating",
  "managedUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "canvasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "widgetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "widgetName": "Example widgetName",
  "warnings": []
}

meta · object

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.

Show child attributes