> ## Documentation Index > Fetch the complete documentation index at: https://docs.feedspace.io/llms.txt > Use this file to discover all available pages before exploring further. # Update Review Form > Updates an existing review form by ID. ## OpenAPI ````yaml PUT /forms/{feed_form_id} openapi: 3.1.0 info: title: Feedspace API description: Feedspace API v3 - Feedback and testimonial management platform license: name: MIT version: 1.0.0 servers: - url: https://api.feedspace.io/v3 security: [] paths: /forms/{feed_form_id}: put: tags: - ReviewForms summary: Update a review form description: Updates an existing review form by ID. operationId: updateReviewForm parameters: - name: feed_form_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReviewFormInput' responses: '200': description: Review form updated successfully. content: application/json: schema: type: object properties: message: type: string examples: success: value: message: Form Updated Successfully security: - basicAuth: [] components: schemas: ReviewFormInput: type: object description: >- Request body for creating or updating a review form. Most fields are optional. Conditional requirements apply based on enabled features. properties: name: type: string description: Name of the review form (required, max 140 characters) maxLength: 140 is_paused: type: boolean description: >- Pause or unpause the form. When this field is present, only this field is validated. description: type: - string - 'null' description: Form description page_title: type: - string - 'null' description: Title displayed on the form page page_main_message: type: - string - 'null' description: Main message or description for the form page (supports HTML) messaging_description: type: - string - 'null' description: Messaging description (supports HTML) page_image: type: - string - 'null' format: binary description: Image file for the form page (optional, max 15MB) hide_image: type: - integer - 'null' enum: - 0 - 1 description: Hide the page image (1 = yes, 0 = no) favicon: type: - string - 'null' description: Favicon path review_label_ids: type: - array - 'null' description: Array of review label IDs (each must be 26 characters, distinct) items: type: string minLength: 26 maxLength: 26 allow_video_recording: type: - integer - 'null' enum: - 0 - 1 description: >- Enable video recording (1 = yes, 0 = no). When enabled, video_button_label is required. video_button_label: type: - string - 'null' description: >- Label for the video recording button (required if allow_video_recording is 1) allow_screen_recording: type: - integer - 'null' enum: - 0 - 1 description: >- Enable screen recording (1 = yes, 0 = no). When enabled, screen_button_label is required. screen_button_label: type: - string - 'null' description: >- Label for the screen recording button (required if allow_screen_recording is 1) allow_audio_recording: type: - integer - 'null' enum: - 0 - 1 description: >- Enable audio recording (1 = yes, 0 = no). When enabled, audio_button_label is required. audio_button_label: type: - string - 'null' description: >- Label for the audio recording button (required if allow_audio_recording is 1) allow_text_review: type: - integer - 'null' enum: - 0 - 1 description: >- Enable text review (1 = yes, 0 = no). When enabled, text_button_label is required. text_button_label: type: - string - 'null' description: >- Label for the text review button (required if allow_text_review is 1) allow_upload_file_option: type: - integer - 'null' enum: - 0 - 1 description: >- Enable file upload option (1 = yes, 0 = no). When enabled, text_file_upload_label is required. text_file_upload_label: type: - string - 'null' description: >- Label for the file upload input (required if allow_upload_file_option is 1) allow_files: type: - array - 'null' items: type: string description: Allowed file types for upload (e.g., all_video) allow_review_type: type: - string - 'null' enum: - '0' - '1' description: 'Review type: ''0'' = text only comment, ''1'' = text rating with comment' remark_placeholder: type: - string - 'null' description: >- Placeholder text for remarks (required in certain review type configurations) option_to_add_remark: type: - integer - 'null' enum: - 0 - 1 description: Option to add remark (1 = yes, 0 = no) is_required_remark: type: - integer - 'null' enum: - 0 - 1 description: Is remark required (1 = yes, 0 = no) additionalinfo: type: - array - 'null' items: type: string description: >- Array of additional info fields (e.g., 'other_text', 'other_text2', 'other_text3', 'consent') other_text_label: type: - string - 'null' description: >- Label for other_text field (required if 'other_text' in additionalinfo) other_text_placeholder: type: - string - 'null' description: >- Placeholder for other_text field (required if 'other_text' in additionalinfo) other_text2_label: type: - string - 'null' description: >- Label for other_text2 field (required if 'other_text2' in additionalinfo) other_text2_placeholder: type: - string - 'null' description: >- Placeholder for other_text2 field (required if 'other_text2' in additionalinfo) other_text3_label: type: - string - 'null' description: >- Label for other_text3 field (required if 'other_text3' in additionalinfo) other_text3_placeholder: type: - string - 'null' description: >- Placeholder for other_text3 field (required if 'other_text3' in additionalinfo) consent_label: type: - string - 'null' description: >- Consent label text (required if 'consent' in additionalinfo, must contain valid link format) thank_you_type: type: - string - 'null' enum: - thank_you_page - redirection description: Thank you page type thankyou_title: type: - string - 'null' description: Thank you page title thankyou_message: type: - string - 'null' description: Thank you page message thankyou_reveal_text: type: - string - 'null' description: Thank you reveal text thankyou_redirection_url: type: - string - 'null' description: >- Thank you redirection URL (required if thank_you_type is 'redirection') format: uri allow_video_and_shareable_link: type: - string - 'null' enum: - '0' - '1' description: Allow video and shareable link (1 = yes, 0 = no) other_review_platforms_enabled: type: - integer - 'null' enum: - 0 - 1 description: Enable other review platforms (1 = yes, 0 = no) other_review_platforms: type: - array - 'null' description: >- Array of other review platforms (required if other_review_platforms_enabled is 1 and provided, min 1 item) items: type: object properties: url: type: string description: Platform review URL (required) format: uri platform: type: - string - 'null' description: >- Platform identifier (optional, auto-detected from URL if not provided). Allowed values: google, trustpilot, facebook, clutch, etc. is_enabled: type: - boolean - 'null' description: Whether the platform is enabled (optional, defaults to true) button_text: type: - string - 'null' description: Custom button text for the platform icon: type: - string - 'null' description: Icon filename for the platform required: - url minItems: 1 thankyou_affiliate_link: type: - string - 'null' description: >- Thank you page affiliate link (URL with or without scheme, will be normalized to https://) thankyou_is_enable_affiliate_link: type: - integer - 'null' enum: - 0 - 1 description: Enable thank you affiliate link (1 = yes, 0 = no) hide_signup_section: type: - integer - 'null' enum: - 0 - 1 description: Hide signup section (1 = yes, 0 = no) allow_star_redirection: type: - boolean - 'null' description: Enable star redirection (true = yes, false = no) star_redirection_min_rating: type: - integer - 'null' description: Minimum rating for star redirection (1-5) star_redirection_platforms: type: - array - 'null' description: >- Array of star redirection platforms (required if allow_star_redirection is true and provided, min 1 item) items: type: object properties: url: type: string description: Platform review URL (required) format: uri platform: type: - string - 'null' description: >- Platform identifier (optional, auto-detected from URL if not provided) is_enabled: type: - boolean - 'null' description: Whether the platform is enabled (optional, defaults to true) button_text: type: - string - 'null' description: Custom button text for the platform icon: type: - string - 'null' description: Icon filename for the platform button_style: type: - object - 'null' description: Button styling configuration additionalProperties: type: string required: - url minItems: 1 allow_introduction_media: type: - integer - 'null' enum: - 0 - 1 description: Allow introduction media (1 = yes, 0 = no) introduction_media: type: - array - 'null' description: Introduction media array (optional, max 1 item) items: type: object properties: type: type: string enum: - video - gif description: Media type (required) details: type: object properties: file: type: - string - 'null' format: binary description: 'GIF file (required for gif type, max 15MB, mime: gif)' file_name: type: string description: File name (required) original_url: type: - string - 'null' description: >- Original video URL (required for video type, must start with S3 URL) format: uri original_path: type: - string - 'null' description: Original video path (required for video type) required: - type - details maxItems: 1 allow_thankyou_message_media: type: - integer - 'null' enum: - 0 - 1 description: Allow thank you message media (1 = yes, 0 = no) thankyou_message_media: type: - array - 'null' description: Thank you message media array (optional, max 1 item) items: type: object properties: type: type: string enum: - video - gif description: Media type (required) details: type: object properties: file: type: - string - 'null' format: binary description: 'GIF file (required for gif type, max 15MB, mime: gif)' file_name: type: string description: File name (required) original_url: type: - string - 'null' description: >- Original video URL (required for video type, must start with S3 URL) format: uri original_path: type: - string - 'null' description: Original video path (required for video type) required: - type - details maxItems: 1 has_allow_media_review: type: - integer - 'null' enum: - 0 - 1 description: Allow media review (1 = yes, 0 = no) has_capture_star_rating: type: - integer - 'null' enum: - 0 - 1 description: Capture star rating (1 = yes, 0 = no) has_capture_comment: type: - integer - 'null' enum: - 0 - 1 description: Capture comment (1 = yes, 0 = no) has_allow_image_uploads: type: - integer - 'null' enum: - 0 - 1 description: Allow image uploads (1 = yes, 0 = no) show_reviews_on_form: type: - integer - 'null' enum: - 0 - 1 description: Show reviews on form (1 = yes, 0 = no) reviews_widget_id: type: - string - 'null' format: uuid description: Reviews widget UUID (required if show_reviews_on_form is 1) is_enable_affiliate_link: type: - integer - 'null' enum: - 0 - 1 description: Enable branding affiliate link (1 = yes, 0 = no) branding_affiliate_link: type: - string - 'null' description: >- Branding affiliate link (URL with or without scheme, will be normalized to https://) submit_attributes: type: - object - 'null' description: Submit page attributes additionalProperties: true thankyou_attributes: type: - object - 'null' description: Thank you page attributes additionalProperties: true form_attributes: type: - object - 'null' description: Form configuration attributes additionalProperties: true custom_attributes: type: - object - 'null' description: Custom styling and configuration attributes additionalProperties: true media_attributes: type: - object - 'null' description: Media configuration attributes additionalProperties: true allow_auto_detect_language: type: - integer - 'null' enum: - 0 - 1 description: Allow auto-detect language (1 = yes, 0 = no) allow_to_remove_branding: type: - integer - 'null' enum: - 0 - 1 description: Allow to remove branding (1 = yes, 0 = no) allow_custom_domain: type: - integer - 'null' enum: - 0 - 1 description: Allow custom domain (1 = yes, 0 = no) required: - name securitySchemes: basicAuth: type: http scheme: basic description: >- HTTP Basic Authentication using API Key and Secret Key. The credentials should be Base64 encoded in the format 'api_key:secret_key'. You can obtain your API Key and Secret Key from Feedspace → Automation → API (https://app.feedspace.io/automation/api). ````