> ## Documentation Index
> Fetch the complete documentation index at: https://developers.aimtell.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Opt-in Prompt
> Fetches an opt-in prompt by ID
## OpenAPI
````yaml /api-reference/misc-openapi.json get /prod/prompt/{id}
openapi: 3.1.0
info:
title: other
version: '1.1'
servers:
- url: https://api.aimtell.com
security:
- sec0: []
tags:
- name: Analytics
description: Analytics and reporting
- name: Logs
description: Activity logs
- name: Pixels
description: Tracking pixels
- name: Prompts
description: Subscription prompt management
paths:
/prod/prompt/{id}:
get:
tags:
- Prompts
summary: Get Opt-in Prompt
description: Fetches an opt-in prompt by ID
operationId: api-get-opt-in-prompt
parameters:
- name: id
in: path
description: Prompt ID
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value:
id: '123'
uid: 12abcd3456e7
idSite: '147'
name: Prompt 1
header_text: Want updates?
header_text_color: '#000000'
body_text: Get the latest and greatest
body_text_color: '#000000'
cancel_button_text: No, thanks
cancel_button_text_color: '#4e99cf'
cancel_button_color: '#ffffff'
approve_button_text: Yes, please
approve_button_text_color: '#4e99cf'
approve_button_color: '#ffffff'
active: '1'
icon_url: https://cdn.aimtell.io/user/uploads/147-1588184063.png
prompt_color: ''
prompt_type: '3'
prompt_position: ''
prompt_sticky: '0'
createdAt: '2020-04-29 18:13:33'
updatedAt: '2020-07-28 18:39:51'
code: "\n\t\t\t\t
\n\t\t\t\t \n\t\t\t\t \n\t\t\t\t \n\t\t\t\t\t\t\t
\n\t\t\t\t \n\t\t\t\t \n\t\t\t\t \n\t\t\t\t Want updates?\n\t\t\t\t Get the latest and greatest\n\t\t\t\t \n\t\t\t\t \n\t\t\t\t \t by Aimtell\n\t\t\t\t \tYes, please\n\t\t\t\t \t No, thanks \n\t\t\t\t \n\t\t\t\t\t\t\n\t\t\t\t \n\t\t\t\t \n\t\t\t\t "
schema:
type: object
properties:
id:
type: string
example: '123'
uid:
type: string
example: 12abcd3456e7
idSite:
type: string
example: '147'
name:
type: string
example: Prompt 1
header_text:
type: string
example: Want updates?
header_text_color:
type: string
example: '#000000'
body_text:
type: string
example: Get the latest and greatest
body_text_color:
type: string
example: '#000000'
cancel_button_text:
type: string
example: No, thanks
cancel_button_text_color:
type: string
example: '#4e99cf'
cancel_button_color:
type: string
example: '#ffffff'
approve_button_text:
type: string
example: Yes, please
approve_button_text_color:
type: string
example: '#4e99cf'
approve_button_color:
type: string
example: '#ffffff'
active:
type: string
example: '1'
icon_url:
type: string
example: https://cdn.aimtell.io/user/uploads/147-1588184063.png
prompt_color:
type: string
example: ''
prompt_type:
type: string
example: '3'
prompt_position:
type: string
example: ''
prompt_sticky:
type: string
example: '0'
createdAt:
type: string
example: '2020-04-29 18:13:33'
updatedAt:
type: string
example: '2020-07-28 18:39:51'
code:
type: string
example: "\n\t\t\t\t\n\t\t\t\t \n\t\t\t\t \n\t\t\t\t \n\t\t\t\t\t\t\t\n\t\t\t\t \n\t\t\t\t \n\t\t\t\t \n\t\t\t\t Want updates?\n\t\t\t\t Get the latest and greatest\n\t\t\t\t \n\t\t\t\t \n\t\t\t\t \t by Aimtell\n\t\t\t\t \tYes, please\n\t\t\t\t \t No, thanks \n\t\t\t\t \n\t\t\t\t\t\t\n\t\t\t\t \n\t\t\t\t \n\t\t\t\t "
'401':
description: '401'
content:
application/json:
examples:
Result:
value:
result: error
message: Invalid token.
error_code: 71831
schema:
type: object
properties:
result:
type: string
example: error
message:
type: string
example: Invalid token.
error_code:
type: integer
example: 71831
default: 0
deprecated: false
components:
securitySchemes:
sec0:
type: apiKey
name: X-Authorization-Api-Key
in: header
x-default: ''
````