Update a copilot

Beta

PUT

Path parameters

copilot_idstringRequired

Request

This endpoint expects an object.

workflow_idstringOptional

img_urlstringOptional

display_namestringOptional

mode"light" or "dark"OptionalDefaults to light

Allowed values: lightdark

colorsmap from strings to stringsOptional

fabmap from strings to optional strings or integersOptional

message_placeholderstringOptional

initial_activitylist of anyOptional

allowed_originsstringOptional

Response

Successful Response

dataobjectOptional

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 '{}'

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       "colors": {
9         "key": "value"
10       },
11       "message_placeholder": "message_placeholder",
12       "allowed_origins": "allowed_origins"
13     },
14     "last_updated_at": "2024-01-15T09:30:00Z",
15     "created_at": "2024-01-15T09:30:00Z",
16     "created_by": {
17       "type": "user",
18       "details": {
19         "user_id": "user_id",
20         "org_id": "org_id",
21         "scout_organization_id": "scout_organization_id",
22         "email": {
23           "key": "value"
24         }
25       }
26     },
27     "last_updated_by": {
28       "type": "user",
29       "details": {
30         "user_id": "user_id",
31         "org_id": "org_id",
32         "scout_organization_id": "scout_organization_id",
33         "email": {
34           "key": "value"
35         }
36       }
37     },
38     "revision_id": "revision_id",
39     "copilot_id": "copilot_id",
40     "is_draft": true
41   }
42 }

Built with

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 '{}'

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	"colors": {
9	"key": "value"
10	},
11	"message_placeholder": "message_placeholder",
12	"allowed_origins": "allowed_origins"
13	},
14	"last_updated_at": "2024-01-15T09:30:00Z",
15	"created_at": "2024-01-15T09:30:00Z",
16	"created_by": {
17	"type": "user",
18	"details": {
19	"user_id": "user_id",
20	"org_id": "org_id",
21	"scout_organization_id": "scout_organization_id",
22	"email": {
23	"key": "value"
24	}
25	}
26	},
27	"last_updated_by": {
28	"type": "user",
29	"details": {
30	"user_id": "user_id",
31	"org_id": "org_id",
32	"scout_organization_id": "scout_organization_id",
33	"email": {
34	"key": "value"
35	}
36	}
37	},
38	"revision_id": "revision_id",
39	"copilot_id": "copilot_id",
40	"is_draft": true
41	}
42	}