Form

patch

https://api.marketcircle.net/v1/forms/{id}

Modify a form

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See Form for the attributes. Attributes you leave out are not changed, and a values array only replaces the fields it names:

{ "values": [{ "name": "Rating", "value": 5 }] }

The form's definition can't be changed; including it returns 400 with {"error":"can_not_include_definition"}. A form in the trash can't be edited (404 with {"error":"trashed_object"}) until you restore it with {"trashed": false}. A successful update returns 204 No Content.

Path Params

int32

required

The form ID

Body Params

name

string

Name of the form.

values

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. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

keywords

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

appointments

Appointments linked to the form. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

contacts

Contacts linked to the form. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

companies

Companies linked to the form. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

opportunities

Opportunities linked to the form. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

projects

Projects linked to the form. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

tasks

Tasks linked to the form. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

groups

Groups linked to the form. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

notes

Notes linked to the form. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

email_messages

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

owner

string

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

trashed

boolean

Set to false to restore the form from the trash. Use DELETE to move it to the trash.

Responses

204

204 No Content

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400400 Bad Request

404404 Not Found