Beta

Update a copilot

PUT

1 curl -X PUT https://api-prod.scoutos.com/v2/copilots/copilot_id \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Play

200Updated

1 {
2   "data": {
3     "copilot_config": {
4       "workflow_id": "workflow_id",
5       "img_url": "img_url",
6       "display_name": "display_name",
7       "mode": "light",
8       "code_theme": "light",
9       "colors": {
10         "key": "value"
11       },
12       "loading_text": "loading_text",
13       "message_placeholder": "message_placeholder",
14       "allowed_origins": "allowed_origins"
15     },
16     "last_updated_at": "2024-01-15T09:30:00Z",
17     "created_at": "2024-01-15T09:30:00Z",
18     "created_by": {
19       "type": "user",
20       "details": {
21         "user_id": "user_id",
22         "org_id": "org_id",
23         "scout_organization_id": "scout_organization_id",
24         "email": {
25           "key": "value"
26         }
27       }
28     },
29     "last_updated_by": {
30       "type": "user",
31       "details": {
32         "user_id": "user_id",
33         "org_id": "org_id",
34         "scout_organization_id": "scout_organization_id",
35         "email": {
36           "key": "value"
37         }
38       }
39     },
40     "revision_id": "revision_id",
41     "copilot_id": "copilot_id",
42     "is_draft": true
43   }
44 }

Path parameters

copilot_idstringRequired

Request

This endpoint expects an object.

workflow_idstringOptional

img_urlstringOptional

display_namestringOptional

modeenumOptionalDefaults to light

Allowed values:

code_themeenumOptionalDefaults to dark

Allowed values:

colorsmap from strings to stringsOptional

fabmap from strings to optional strings or integersOptional

loading_textstringOptional

message_placeholderstringOptional

initial_activitylist of anyOptional

allowed_originsstringOptional

Response

Successful Response

dataobjectOptional

Update a copilot

Path parameters

Headers

Request

Response

Errors