Update a Copilot Config
Re-saves a Copilot config. The same operation as creating one, with the id supplied, and asynchronous in the same way. When it was created, by whom, and any completed deploy are preserved - a re-save cannot rewrite them.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The unique identifier for the Copilot config.
24^[a-z0-9]{24}$Body
The workspace JSON. Create and re-save take the same body - the only difference is whether an id is supplied - so a rule added to one cannot drift from the other. Ownership (organisation, createdBy, lastChangedBy) is established from the session, never from here.
Required, and required after trimming - a name of spaces is not a name.
single is readable but cannot be saved.
grid, hybrid How much room the Copilot has in the agent's workspace.
At least one widget - the other half of the save gate, alongside a name.
24^[a-z0-9]{24}$The CXone agentic profile to link this Copilot to, by its agentAssistId. Omit or send empty for none. Needs agentic profiles switched on and an organisation connected to CXone.
Response
Returns the stored Copilot config object.
The object id of the Copilot config
The name of the Copilot config
The description of the Copilot config
The referenceId of the Copilot config
The id of the project the Copilot config belongs to
The id of the organisation the Copilot config belongs to
Unix timestamp (seconds) of when the Copilot config was created
Unix timestamp (seconds) of when the Copilot config was last changed
The id of the user who created the Copilot config
The id of the user who last changed the Copilot config
The layout mode of the Copilot config
grid, hybrid, single How much room the Copilot has in the agent's workspace.
Always an array, never null, even when empty.
True once a save has succeeded at least once. Not the same as published โ publishing is asynchronous, so a config is routinely saved while still unpublished.
Whether the Copilot config is published
The last completed deploy, or null if none has finished.
The CXone agentic profile picked for this Copilot, by its agentAssistId. Absent when none is picked.
Whether this Copilot's endpoint has been written into that profile yet. Set after a successful deploy, so it can trail a save.
True while a deploy has landed but its profile link, switch or clear is still in flight. A polling client keeps polling while this is true.