Form

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/quietcopy.com/forms/form_1",
  "$type": "Form",
  "fields": {}
}

RelationshipsCopy Anchor Link

• A Form captures many Leads: each Form submission creates a Lead. captures, inverse capturedBy.
• A Form is embedded in many Pages: Forms sit on Pages; one Form appears on many Pages. embeddedIn, inverse embeds.

VerbsCopy Anchor Link

1. createCreates a Form.
   POST /{namespace}/formsdoForm.created
2. getReturns one Form by id.
   GET /{namespace}/forms/{id}readNo Event
3. listReturns Forms, newest first, one page at a time.
   GET /{namespace}/formsreadNo Event
4. updateChanges the given properties of a Form.
   PATCH /{namespace}/forms/{id}doForm.updated
5. deleteDeletes a Form; its history is kept.
   DELETE /{namespace}/forms/{id}doForm.deleted

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Add a form to TutorLoop.

ExampleCopy Anchor Link

The booking Form on a home-inspector directory asks for the address, the closing date, and a phone number. Each submission creates a Lead and offers it to three inspectors.