Sign in
Prompt Payloads

Update a Prompt Payload

Updates an existing sample payload's variables and/or optional name. Only editors can update.

put/v1/prompts/{id}/payloads/{payloadID}

Path parameters

idstring uuid required

Unique prompt UUID.

payloadIDstring uuid required

Unique payload UUID.

Request body

namestring

Optional name for this sample payload.

variablesobject

JSON object containing variable names and sample values.

Example request

{
  "name": "Admin Sample",
  "variables": {
    "user": "Alice",
    "role": "Editor"
  }
}

Response

Prompt payload updated successfully

Example response

{
  "payload": {
    "variables": {
      "user": "Arpit",
      "role": "Admin"
    }
  }
}

Changes

Changed in 2 of the 18 revisions of this API.2