Create Widget
POST /v2/partner/widgets
Required scopes
partner:widgets:write
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | createWidget |
| Tags | Operations |
Request body
Required
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | widget |
| team_id * | id | UUID v4. |
| kind * | enum (8) | direct_depositcard_on_filemobile_app_downloadenrollmentopt_insurveysecure_personalizationusps |
| name * | string | |
| display_name | string | |
| config * | object | |
| theme_id | string (uuid) | |
| is_active * | boolean | |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Responses
201
Created
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | widget |
| team_id * | id | UUID v4. |
| kind * | enum (8) | direct_depositcard_on_filemobile_app_downloadenrollmentopt_insurveysecure_personalizationusps |
| name * | string | |
| display_name | string | |
| config * | object | |
| theme_id | string (uuid) | |
| is_active * | boolean | |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Example request
POST https://api.digitalonboarding.com/v2/partner/widgets
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }