Update a Form

JavaScript

import Moonbase from '@moonbaseai/sdk';

const client = new Moonbase({
  apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
});

const form = await client.forms.update('id', {
  business_email_required: true,
  name: 'Updated Form',
});

console.log(form.id);

import os
from moonbase import Moonbase

client = Moonbase(
    api_key=os.environ.get("MOONBASE_API_KEY"),  # This is the default and can be omitted
)
form = client.forms.update(
    id="id",
    business_email_required=True,
    name="Updated Form",
)
print(form.id)

package main

import (
	"context"
	"fmt"

	"github.com/moonbaseai/moonbase-sdk-go"
	"github.com/moonbaseai/moonbase-sdk-go/option"
)

func main() {
	client := moonbase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	form, err := client.Forms.Update(
		context.TODO(),
		"id",
		moonbase.FormUpdateParams{
			BusinessEmailRequired: moonbase.Bool(true),
			Name:                  moonbase.String("Updated Form"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", form.ID)
}

curl --request PATCH \
  --url https://api.moonbase.ai/v0/forms/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Form",
  "business_email_required": true
}
'

{
  "id": "1CLJt2v5aNd8G5SGzEaeVU",
  "type": "form",
  "updated_at": "2025-02-17T16:00:00.000Z",
  "name": "Updated Form",
  "pages_enabled": false,
  "business_email_required": true,
  "pages_url": "https://moonbase.page/1CLJt2v5aNd8G5SGzEaeVU",
  "collection": {
    "id": "1CLJt2v5pkpkAnvdgXfEcF",
    "type": "collection",
    "ref": "form_1cljt2v5and8g5sgzeaevu"
  },
  "html_embed": "<!-- Moonbase JS: Add this to your <head> section -->\n<script src=\"https://moonbase-js.com/v1.js\" type=\"module\"></script>\n\n<!-- Moonbase Form: Add this where you want to display the form -->\n<form data-moonbase-id=\"1CLJt2v5aNd8G5SGzEaeVU\">\n  <!-- Fields: do not change the \"name\" attributes of the <input /> elements -->\n  <div>\n    <!-- This \"email\" field is a required field (but others can be removed) -->\n    <label for=\"email_Qqo\">Email</label>\n    <input type=\"email\" id=\"email_Qqo\" name=\"field_1CLJt2v6KXDyzDuM57pQqo\" required />\n  </div>\n  <div>\n    <!-- This \"name\" field can be removed if not needed -->\n    <label for=\"name_pj2\">Name</label>\n    <input type=\"text\" id=\"name_pj2\" name=\"field_1CLJt2v6592N5WQzNpjpj2\" />\n  </div>\n\n  <!-- Buttons: you can add other buttons if needed -->\n  <button type=\"submit\">Submit</button>\n\n  <!-- CAPTCHA: this is where we will show a CAPTCHA challenge if needed -->\n  <div data-moonbase-role=\"captcha\"></div>\n\n  <!-- Done Message: show once the form is successfully submitted -->\n  <div data-moonbase-role=\"done\" hidden>Thanks!</div>\n</form>",
  "created_at": "2025-02-17T16:00:00.000Z"
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "400",
      "title": "Bad Request",
      "detail": "The request could not be understood due to malformed syntax or invalid parameters."
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "401",
      "title": "Unauthorized",
      "detail": "Invalid or missing API key or JWT. You should provide your Moonbase API Key or JWT in the authorization header, in the format: \"Authorization: Bearer MOONBASE_API_KEY\""
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "403",
      "title": "Forbidden"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "404",
      "title": "Not Found"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "422",
      "title": "Unprocessable Entity",
      "detail": "Name can't be blank",
      "source": {
        "pointer": "/name"
      }
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "429",
      "title": "Too Many Requests"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "500",
      "title": "Internal Server Error"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "503",
      "title": "Service Unavailable",
      "detail": "The service is temporarily unavailable, please try again later."
    }
  ]
}

PATCH

forms

{id}

JavaScript

import Moonbase from '@moonbaseai/sdk';

const client = new Moonbase({
  apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
});

const form = await client.forms.update('id', {
  business_email_required: true,
  name: 'Updated Form',
});

console.log(form.id);

import os
from moonbase import Moonbase

client = Moonbase(
    api_key=os.environ.get("MOONBASE_API_KEY"),  # This is the default and can be omitted
)
form = client.forms.update(
    id="id",
    business_email_required=True,
    name="Updated Form",
)
print(form.id)

package main

import (
	"context"
	"fmt"

	"github.com/moonbaseai/moonbase-sdk-go"
	"github.com/moonbaseai/moonbase-sdk-go/option"
)

func main() {
	client := moonbase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	form, err := client.Forms.Update(
		context.TODO(),
		"id",
		moonbase.FormUpdateParams{
			BusinessEmailRequired: moonbase.Bool(true),
			Name:                  moonbase.String("Updated Form"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", form.ID)
}

curl --request PATCH \
  --url https://api.moonbase.ai/v0/forms/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Form",
  "business_email_required": true
}
'

{
  "id": "1CLJt2v5aNd8G5SGzEaeVU",
  "type": "form",
  "updated_at": "2025-02-17T16:00:00.000Z",
  "name": "Updated Form",
  "pages_enabled": false,
  "business_email_required": true,
  "pages_url": "https://moonbase.page/1CLJt2v5aNd8G5SGzEaeVU",
  "collection": {
    "id": "1CLJt2v5pkpkAnvdgXfEcF",
    "type": "collection",
    "ref": "form_1cljt2v5and8g5sgzeaevu"
  },
  "html_embed": "<!-- Moonbase JS: Add this to your <head> section -->\n<script src=\"https://moonbase-js.com/v1.js\" type=\"module\"></script>\n\n<!-- Moonbase Form: Add this where you want to display the form -->\n<form data-moonbase-id=\"1CLJt2v5aNd8G5SGzEaeVU\">\n  <!-- Fields: do not change the \"name\" attributes of the <input /> elements -->\n  <div>\n    <!-- This \"email\" field is a required field (but others can be removed) -->\n    <label for=\"email_Qqo\">Email</label>\n    <input type=\"email\" id=\"email_Qqo\" name=\"field_1CLJt2v6KXDyzDuM57pQqo\" required />\n  </div>\n  <div>\n    <!-- This \"name\" field can be removed if not needed -->\n    <label for=\"name_pj2\">Name</label>\n    <input type=\"text\" id=\"name_pj2\" name=\"field_1CLJt2v6592N5WQzNpjpj2\" />\n  </div>\n\n  <!-- Buttons: you can add other buttons if needed -->\n  <button type=\"submit\">Submit</button>\n\n  <!-- CAPTCHA: this is where we will show a CAPTCHA challenge if needed -->\n  <div data-moonbase-role=\"captcha\"></div>\n\n  <!-- Done Message: show once the form is successfully submitted -->\n  <div data-moonbase-role=\"done\" hidden>Thanks!</div>\n</form>",
  "created_at": "2025-02-17T16:00:00.000Z"
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "400",
      "title": "Bad Request",
      "detail": "The request could not be understood due to malformed syntax or invalid parameters."
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "401",
      "title": "Unauthorized",
      "detail": "Invalid or missing API key or JWT. You should provide your Moonbase API Key or JWT in the authorization header, in the format: \"Authorization: Bearer MOONBASE_API_KEY\""
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "403",
      "title": "Forbidden"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "404",
      "title": "Not Found"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "422",
      "title": "Unprocessable Entity",
      "detail": "Name can't be blank",
      "source": {
        "pointer": "/name"
      }
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "429",
      "title": "Too Many Requests"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "500",
      "title": "Internal Server Error"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "503",
      "title": "Service Unavailable",
      "detail": "The service is temporarily unavailable, please try again later."
    }
  ]
}

Authorizations

Authorization

string

header

required

Your Moonbase API key.

Path Parameters

string

required

The ID of the Form to update.

Body

application/json

Parameters for updating a Form.

name

string

The new name for the form.

redirect_url

null | string

Updated redirect URL, or null to clear. Omit to leave the existing value unchanged. Liquid template rendered at submission time with form field values under submission.<key> (keyed by the field's key) plus UTM params (utm_source, utm_medium, utm_campaign, utm_term, utm_content) automatically appended. Use the uri_encode filter for URL-safe values. The rendered URL must parse as a valid URL or the submission errors.

pages_enabled

boolean

If true, a Moonbase Pages hosted page is enabled for this form, providing a standalone public URL for sharing.

business_email_required

boolean

If true, submissions require a business email address.

Response

Successful response.

A Form provides a way to create Items in a Collection, often via a public URL for external users. Each form submission creates a new item.

type

string

required

String representing the object’s type. Always form for this object.

Allowed value: "form"

string

required

Unique identifier for the object.

name

string

required

The name of the form, used as the title on its public page.

pages_enabled

boolean

required

If true, a Moonbase Pages hosted page is enabled for this form, providing a standalone public URL for sharing.

business_email_required

boolean

required

true if submissions require a business email address, blocking free and disposable providers.

collection

CollectionPointer · object

required

The Collection that submissions to this form are saved to.

Show child attributes

html_embed

string

required

The HTML snippet for embedding the form on your website.

created_at

string<date-time>

required

Time at which the object was created, as an ISO 8601 timestamp in UTC.

updated_at

string<date-time>

required

Time at which the object was last updated, as an ISO 8601 timestamp in UTC.

redirect_url

string

Optional URL the user is redirected to after a successful submission. When unset, no redirect occurs. Stored as a Liquid template; rendered at submission time with form field values under submission.<key> (keyed by the field's key) plus UTM params (utm_source, utm_medium, utm_campaign, utm_term, utm_content) automatically appended. Use the uri_encode filter for URL-safe values, e.g. https://example.com/thanks?email={{ submission.email | uri_encode }}. The rendered URL must parse as a valid URL or the submission errors.

pages_url

string<uri>

The public URL for the form, if pages_enabled is true.

⌘I

Introduction

Core Concepts

API Reference

Authorizations

Path Parameters

Body

Response