Skip to main content
PUT
/
v2
/
Pearl
/
{pearlId}
Update Pearl
curl --request PUT \
  --url https://api.nlpearl.ai/v2/Pearl/{pearlId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "pearl": {
    "agents": [
      {
        "name": "<string>",
        "voiceId": "<string>"
      }
    ],
    "agentPersonality": "<string>",
    "timeZone": "<string>",
    "modelType": 123,
    "companyName": "<string>",
    "companyDescription": "<string>",
    "knowledgeBase": "<string>",
    "memory": true,
    "speechRecognitionKeywords": [
      {
        "word": "<string>",
        "pronunciations": [
          "<string>"
        ]
      }
    ],
    "openingSentence": "<string>",
    "flowScript": "<string>",
    "transferCallSettings": [
      {
        "transferCallPhoneNumber": "<string>",
        "triggerDescription": "<string>",
        "warmTransferMessage": "<string>"
      }
    ],
    "smsSettings": [
      {
        "body": "<string>",
        "triggerDescription": "<string>"
      }
    ],
    "emailSettings": [
      {
        "subject": "<string>",
        "body": "<string>",
        "triggerDescription": "<string>",
        "smtpSettings": {
          "id": "<string>",
          "provider": 123,
          "smtpServer": "<string>",
          "port": 123,
          "enableSsl": true,
          "senderEmail": "<string>",
          "senderPassword": "<string>",
          "displayName": "<string>"
        }
      }
    ],
    "apiSettings": [
      {
        "name": "<string>",
        "method": 123,
        "endpointUrl": "<string>",
        "body": [
          {
            "key": "<string>",
            "variableId": "<string>",
            "type": 123,
            "value": "<string>",
            "required": true
          }
        ],
        "headers": {},
        "triggerDescription": "<string>",
        "description": "<string>"
      }
    ],
    "successDescription": "<string>",
    "indicatorTags": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "color": 123
      }
    ],
    "notifications": [
      {
        "apiSettings": {
          "name": "<string>",
          "method": 123,
          "endpointUrl": "<string>",
          "body": [
            {
              "key": "<string>",
              "variableId": "<string>",
              "type": 123,
              "value": "<string>",
              "required": true
            }
          ],
          "headers": {},
          "triggerDescription": "<string>",
          "description": "<string>"
        },
        "emailTemplate": {
          "to": [
            "<string>"
          ],
          "cc": [
            "<string>"
          ],
          "subject": "<string>",
          "body": "<string>",
          "triggerDescription": "<string>",
          "smtpSettings": {
            "id": "<string>",
            "provider": 123,
            "smtpServer": "<string>",
            "port": 123,
            "enableSsl": true,
            "senderEmail": "<string>",
            "senderPassword": "<string>",
            "displayName": "<string>"
          }
        },
        "indicatorTagsIds": [
          "<string>"
        ]
      }
    ]
  },
  "variables": [
    {
      "id": "<string>",
      "name": "<string>",
      "group": 123,
      "type": 123,
      "isList": true,
      "description": "<string>",
      "value": "<string>",
      "options": [
        {
          "value": "<string>",
          "code": "<string>"
        }
      ]
    }
  ]
}
'
true

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
pearlId
string
required

The unique identifier of the Pearl.

Body

The updated Pearl flow configuration.

​
name
string | null

The updated name of the Pearl.

​
pearl
object

Updated conversation flow and agent behavior configuration for the Pearl.

​
variables
object[] | null

Variables that can be defined, stored, and used by the agent during conversations. For details on variable groups and how to use variables in supported fields, see: Flow Variables

Response

The Pearl flow was updated successfully.

The response is of type boolean.