Pearl

Update Pearl

Updates the configuration of a Simple Pearl (name, pearl settings and variables). The update applies to the published version of the Pearl: if several versions exist on the platform, only the currently published one is modified. For Pearls, use Update Voice Pearl or Update Text Pearl instead.

put/v2/Pearl/{pearlId}

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v2/Pearl/:pearlId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

pearlIdstring required

The unique identifier of the Pearl.

Request body

namestring nullable

The updated name of the Pearl.

Response

The Pearl flow was updated successfully.

boolean required

Changes

No recorded changes to this operation across all 1 revision of this API.