Back to Developer Center

API v1 Reference

Update Custom Object Form Layout

Updates an existing Form layout for a custom object.

Endpoint

https://api.neoncrm.com/neonws/services/api/customObject/updateCustomObjectFormLayout

Request

https://api.neoncrm.com/neonws/services/api/customObject/updateCustomObjectFormLayout?userSessionId=[session_id]&customObjectFormLayout.objectApiName=Custom_Event_c&customObjectFormLayout.layoutId=53&customObjectFormLayout.layoutName=Test%20Layout%20&customObjectFormLayout.formFields.layoutField.objectApiName=Custom_Event_c&customObjectFormLayout.formFields.layoutField.fieldApiName=name&customObjectFormLayout.formFields.layoutField.objectApiName=Custom_Event_c&customObjectFormLayout.formFields.layoutField.fieldApiName=Title_c&customObjectFormLayout.formFields.layoutField.objectApiName=Custom_Event_c&customObjectFormLayout.formFields.layoutField.fieldApiName=Account_c&customObjectFormLayout.isDefault=true

Response

{
    "updateCustomObjectFormLayoutResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2017-12-19T17:55:37.078+0000",
        "customObjectFormLayout": {
            "layoutId": 53,
            "layoutName": "Test Layout",
            "objectApiName": "Custom_Event_c",
            "formFields": {
                "layoutField": [
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "name"
                    },
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "Title_c"
                    },
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "Account_c"
                    }
                ]
            },
            "isDefault": true
        }
    }
}

Request Parameters

Parameter Required Description
userSessionId Yes
customObjectFormLayout.objectApiName Yes
customObjectFormLayout.layoutId Yes The ID of the form layout to be updated.
customObjectFormLayout.layoutName Yes
customObjectFormLayout.isDefault Whether this layout should be the default (primary) layout. Possible values: true, false. Default: false.
To add fields to your form layout, include both the objectApiName and fieldApiName parameters for each field. Fields will display in the sequence you send them. Fields can be retrieved using the List Custom Object Fields method.
customObjectFormLayout.formFields.layoutField.objectApiName Yes
customObjectFormLayout.formFields.layoutField.fieldApiName Yes
To display a list of child records, you must include information about the relationship. Include the objectApiName, objectLabel, relationId, and relateListLabel parameters for each list. Lists of child records will display in the sequence you send them. Related objects can be retrieved using the List Custom Object Relations method.
customObjectFormLayout.childTables.customObjectRelation.objectApiName
customObjectFormLayout.childTables.customObjectRelation.objectLabel
customObjectFormLayout.childTables.customObjectRelation.relationId
customObjectFormLayout.childTables.customObjectRelation.relateListLabel

Response Parameters

Parameter Description
customObjectFormLayout.layoutId
customObjectFormLayout.layoutName
customObjectFormLayout.objectApiName
customObjectFormLayout.formFields.layoutField.objectApiName
customObjectFormLayout.formFields.layoutField.fieldApiName
customObjectFormLayout.isDefault