POST /widgets

post

https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/widgets

Used to create a widget

Path Params

teamId

uuid

required

ID of Team

Body Params

intro_title

string

The message displayed upon the introduction of the Widget flow.

public_alias

string

The public identifier for the Widget (eg. demo => https://app.usecanopy.com/c/demo). When not explicitly set, a public_alias will be auto generated.

company_name

string

The company name presented in the Widget flow.

brand_color_hex

string

RRGGBB hexadecimal string used for color theming in the Widget flow.

success_message

string

The message displayed upon successful completion of the Widget flow.

on_success_redirect_url

string | null

The URL the user is taken to upon successful completion of the Widget flow.

cobranded_intro_screen

boolean

Whether the enhanced “cobranded” introduction screen is enabled for the Widget flow.

agents

Optional list of agents to update (either list of agent_ids or agent object with agent_id)

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 Response Schema