Skip to main content
PUT
/
prod
/
prompt
/
{id}
Update Opt-in Prompt
curl --request PUT \
  --url https://api.aimtell.com/prod/prompt/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "header_text": "<string>",
  "header_text_color": "<string>",
  "body_text": "<string>",
  "body_text_color": "<string>",
  "cancel_button_text": "<string>",
  "cancel_button_text_color": "<string>",
  "cancel_button_color": "<string>",
  "approve_button_text": "<string>",
  "approve_button_text_color": "<string>",
  "approve_button_color": "<string>",
  "icon_url": "<string>"
}
'
{
  "result": "success",
  "message": "Updated prompt succesfully.",
  "id": "1234"
}

Authorizations

X-Authorization-Api-Key
string
header
default:""
required

Path Parameters

id
string
required

Prompt ID

Body

application/json
name
string

Prompt Name

header_text
string

Prompt Header Text

header_text_color
string

Prompt Header Text Color (hexadecimal color e.g. #000000)

body_text
string

Prompt Body Text

body_text_color
string

Prompt Body Text Color (hexadecimal color e.g. #000000)

cancel_button_text
string

Prompt Cancel Button Text

cancel_button_text_color
string

Prompt Cancel Button Text Color (hexadecimal color e.g. #ffffff)

cancel_button_color
string

Prompt Cancel Button Color (hexadecimal color e.g. #4e99cf)

approve_button_text
string

Prompt Approve Button Text

approve_button_text_color
string

Prompt Approve Button Text Color (hexadecimal color e.g. #ffffff)

approve_button_color
string

Prompt Approve Button Color (hexadecimal color e.g. #4e99cf)

icon_url
string

Prompt Icon URL

Response

200

result
string
Example:

"success"

message
string
Example:

"Updated prompt succesfully."

id
string
Example:

"1234"