Change the App's Assistant

PATCH

/apps/{appId}/assistant

curl --request PATCH \
  --url https://api.passion.io/v1/apps/example/assistant \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "welcomeMessage": "example" }'

Parameters

Path Parameters

appId

required

The id of the App, as Studio shows it.

string

/^[1-9][0-9]*$/

Request Body

Media typeapplication/json

object

name

The name members see.

string

>= 1 characters

welcomeMessage

The first message a member sees.

string

>= 1 characters

Example^generated

{
  "name": "example",
  "welcomeMessage": "example"
}

Responses

200

OK

Media typeapplication/json

object

name

required

The name members see.

string

avatarUrl

required

Any of:

string

string

null

null

ownVoice

required

True when the Assistant speaks with a voice built from the creator’s own recordings in Studio.

boolean

welcomeMessage

required

The first message a member sees.

string

Example^generated

{
  "name": "example",
  "avatarUrl": "example",
  "ownVoice": true,
  "welcomeMessage": "example"
}