Add a Prompt object

POST

/prompt

Add a Prompt object.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorised

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/prompt' \
--header 'Accept: application/json' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
  "reference": "HouseholdAtrributesNumberOfOccupants",
  "data": {
    "keys": [
      "title",
      "button"
    ],
    "values": {
      "title": {
        "type": "title",
        "value": "NUMBER_OF_OCCUPANTS_TITLE"
      },
      "button": {
        "type": "title",
        "value": "NUMBER_OF_OCCUPANTS_BUTTON",
        "operation": "SUBMIT_NUMBER_OF_OCCUPANTS"
      }
    }
  },
  "version": "1.0.1",
  "promptTypeId": "prt84ff4-4435-4d2f-a20c-274595ab8cd4",
  "minimumVersion": "1.0.0"
}'

Response Example

200 - OK

{
  "promptId": "pra24ff3-4435-4d2f-a20c-274595ab8cd4",
  "applicationId": "0537b17c-ab62-491c-8085-9ac2b6206346",
  "reference": "HouseholdAtrributesNumberOfOccupants",
  "isNew": true
}

Modified at 2025-09-21 08:30:22

Find all the prompt objects of an application

get a Prompt User object