Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Service

Update a service

Update fields about a service.

Permissions

This endpoint requires the following permissions:

  • Service:UpdateService for the service.
post/v1/{organization}/service/{service_id}/

Path parameters

service_idstring required

The identifier of the service to update.

The identifier of the service to update.

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

namestring
descriptionstring
is_activeboolean nullable

The activeness of the service. Only updated if not-null.

If set to True and the service is currently inactive, no other service with the same name can be active.

If set to False and the service is currently active, it is deactivated. This will error if the service is used in a simulation unit test.

agent_idstring nullable

The ID of the agent that this service uses. Only updated if not-null.

service_hierarchical_state_machine_idstring nullable

The ID of the service hierarchical state machine that this service uses. Only updated if not-null.

tagsobject nullable

The tags of this service. Only updated if not-null.

keytermsStrippedNonemptyStringAZAZ02[] nullable

A list of keyterms that are easy to get wrong during audio transcriptions that tend to occur commonly in audio sessions using this service. Only updated if not-null.

Response

Succeeded.

{"stackTrail":"paths:/v1/{organization}/service/{service_id}/:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}