SMAO API Documentation
Public APIPrompts

Update a prompt

PATCH
/prompts/{prompt_id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the SMAO dashboard (Settings → API Keys).

In: header

Path Parameters

prompt_id*string
Match^[a-f0-9]{24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Partial update — include only the fields you want to change.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/prompts/65f8fa6f1a9d8e0012ab34cd" \  -H "Content-Type: application/json" \  -d '{    "description": "Reception prompt for inbound customer calls."  }'
{  "data": {    "id": "string",    "name": "string",    "description": "string",    "prompt": "string",    "type": "answering",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "health_score": 0,    "approved": true,    "feedback": "string",    "rated_at": "2019-08-24T14:15:22Z",    "rating_status": null  }}

Get a prompt GET

Get a prompt

Delete a prompt DELETE

Before deleting, clear both `prompt_id` and `email_prompt_id` references from assistants. The server returns 409 `conflict` when the prompt is still assigned through `prompt_id`; clients must not rely on that guard to detect an `email_prompt_id` reference.