Form Definition

patch

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

Create a form definition

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See Form Definition for the attributes. Attributes you leave out are not changed. entities replaces the whole list. A key_definitions array replaces the fields it names and adds new ones; use {"key_definitions": {"remove": [{"name": "Rating"}]}} to remove a field.

A successful update returns 204 No Content.

Path Params

int32

required

The form definition ID

Body Params

name

string

Name of the form definition.

description

string

Description.

is_active

boolean

Whether new forms can be made from this definition.

entities

array of strings

The types of record the form can be added to. Replaces the current list.

entities

key_definitions

The fields on the form (max 64), each identified by name. Sending an array replaces the fields it names and adds new ones. Send {"add": [...], "remove": [{"name": "..."}]} to add or remove specific fields. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

trashed

boolean

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

Responses

204

204 No Content

400400 Bad Request

404404 Not Found