Form

post

https://api.marketcircle.net/v1/forms

Create a form

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See Form for the attributes and how to fill in field values. definition is required: it is the form definition the form is based on, and it can't be changed later.

{
  "name": "Site Visit",
  "definition": "/v1/form_definitions/1000",
  "contacts": [{ "contact": "/v1/contacts/1000" }],
  "values": [
    { "name": "Inspector notes", "value": "All good" },
    { "name": "Rating", "value": 4 },
    { "name": "Areas checked", "values": ["Roof", "Basement"] }
  ]
}

A successful request returns 201 Created with the new form's reference, e.g. {"location": "/v1/forms/6724005"}.

Body Params

name

string

Name of the form.

definition

string

required

Reference of the form definition to base the form on, e.g. /v1/form_definitions/1000. Required; it can't be changed after the form is created.

values

array of objects

Field values, each identified by the field name. Use value for single values and values (an array of option names) for option, combo box and checkbox-list fields. See Form Values. Sending an array only replaces the fields it names; other fields keep their values. Send {"add": [...], "remove": [...]} to add or clear specific fields.

values

keywords

array of strings

List of keyword names (max 64). Keywords that do not exist are created. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

keywords

appointments

array of objects

Appointments linked to the form. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

appointments

contacts

array of objects

Contacts linked to the form. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

contacts

companies

array of objects

Companies linked to the form. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

companies

opportunities

array of objects

Opportunities linked to the form. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

opportunities

projects

array of objects

Projects linked to the form. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

projects

tasks

array of objects

Tasks linked to the form. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

tasks

groups

array of objects

Groups linked to the form. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

groups

notes

array of objects

Notes linked to the form. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

notes

email_messages

array of objects

Emails to link to the form. Write-only: use GET /v1/forms/{id}/emails to list them. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

email_messages

owner

string

Reference to the user responsible for the form, e.g. /v1/users/1000. Defaults to the user making the request.

Responses

201201 Created

400400 Bad Request