Update a copilot

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 '{ 5 "workflow_id": "workflow_id", 6 "img_url": "img_url", 7 "display_name": "display_name", 8 "mode": "light", 9 "code_theme": "dark", 10 "colors": {}, 11 "fab": {}, 12 "loading_text": "loading_text", 13 "message_placeholder": "message_placeholder", 14 "initial_activity": [ 15 null 16 ], 17 "allowed_origins": "allowed_origins" 18 }'

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": "dark", 9 "colors": {}, 10 "fab": {}, 11 "loading_text": "loading_text", 12 "message_placeholder": "message_placeholder", 13 "initial_activity": [ 14 null 15 ], 16 "allowed_origins": "allowed_origins" 17 }, 18 "last_updated_at": "last_updated_at", 19 "created_at": "created_at", 20 "created_by": { 21 "type": "user", 22 "details": { 23 "user_id": "user_id", 24 "org_id": "org_id", 25 "scout_organization_id": "scout_organization_id", 26 "email": {} 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 } 37 }, 38 "revision_id": "revision_id", 39 "copilot_id": "copilot_id", 40 "is_draft": false 41 } 42 }

Path parameters

copilot_idstringRequired

Request

This endpoint expects an object.

workflow_idstring or nullOptional

img_urlstring or nullOptional

display_namestring or nullOptional

modeenumOptionalDefaults to light

Allowed values:

code_themeenumOptionalDefaults to dark

Allowed values:

colorsmap from strings to stringsOptional

fabmap from strings to nullable strings or integersOptional

loading_textstring or nullOptional

message_placeholderstring or nullOptional

initial_activitylist of anyOptional

allowed_originsstring or nullOptional

Response

Successful Response

dataobject or nullOptional

Path parameters

Headers

Request

Response

Errors