---
title: "Request widget url"
method: POST
path: "/users/{user_guid}/widget_urls"
tags: ["mx_platform"]
---

# Request widget url

`POST /users/{user_guid}/widget_urls`

This endpoint allows partners to get a URL by passing the `widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request.

## Path parameters

- `user_guid` string, required

## Headers

- `Accept-Language` string

## Request body

- WidgetRequestBody
  - `widget_url` WidgetRequest
    - `client_redirect_url` string
    - `color_scheme` string
    - `current_institution_code` string
    - `current_institution_guid` string
    - `current_member_guid` string
    - `disable_background_agg` boolean
    - `disable_institution_search` boolean
    - `include_identity` boolean
    - `include_transactions` boolean
    - `insight_guid` string
    - `is_mobile_webview` boolean
    - `microwidget_instance_id` string
    - `mode` string
    - `oauth_referral_source` string
    - `ui_message_version` integer
    - `ui_message_webview_url_scheme` string
    - `update_credentials` boolean
    - `widget_type` string, required

## Response `200`

OK

## Changes

> 21 revisions in range; 1 not diffed.

- **2024-05-07** `bcb952b55c19` — 1 info
  - added the new optional request property `widget_url/microwidget_instance_id`
- **2024-02-28** `1d7939fa1177` — 1 info
  - added the new optional request property `widget_url/insight_guid`
- **2024-02-13** `a13220639504` — 1 warning, 1 info
  - removed the request property `widget_url/insight_guid`
  - added the new optional request property `widget_url/microwidget_instance_id`
- **2024-02-13** `8f0bc3813b96` — 1 info
  - added the new optional request property `widget_url/insight_guid`

[Change history](https://skmtc.dev/mx/apis/mx-platform-api/changes/users/:user_guid/widget_urls/post.md)

---

[API](https://skmtc.dev/mx/apis/mx-platform-api.md) · [All operations](https://skmtc.dev/mx/apis/mx-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mx/mx-platform-api/revisions/4ff1043cdf6f/schema)