Update Fields

Modify fields from a workflow

Request

POST https://api.cloudplan.biz/api/workflow/fields/update

{
    "cp_id": "5F71F6012A4B7030C01715028D88BDB8",
    "fields": [
            {
                    "field_cp_id": "5F71F71459E493333429DFAF7ABC9576",
                    "values": {
                            "x": 20,                                            // Optional
                            "y": 30,                                            // Optional
                            "witdh": 13.97,                                     // Optional
                            "height": 3.11,                                     // Optional
                            "value_pre": 8,                                     // Optional, not allowed for  signatures
                            "page": 1,                                          // Optional
                            "file_cp_id": "5F71CC6A71472280FF7004CF8130D72D",   // Optional
                            "required": true,                                   // Optional
                            "prefilled": true,                                  // Optional, not allowed for  signatures
                            "show_only": false,                                 // Optional, not allowed for  signatures
                            "text": "Budget",                                   // Optional, not allowed for  signatures
                "description_show_pdf": true,                       // Optional
                "description_show_while_signing": true,             // Optional
                "border_show": true,                                // Optional
                "title_underline": true,                            // Optional
                "title_italic": true,                               // Optional
                "title_bold": true,                                 // Optional
                "required_icon_color": "orange",                    // Optional, possible values: "gray", "orange"
                "required_icon": "orange",                          // Optional, possible values: "big", "medium", "small", "none"
                "field_case": "orange",                             // Optional, possible values: "box", "underline"
                "align_content": "left",                            // Optional, possible values: "left", "center", "right"
                "placeholder_text": "Write something",              // Optional
                "font_color": "#ffffff",                            // Optional, only accept html color of six digits
                "title": "New title",                               // Optional
                "description": "new description"                    // Optional
            }
        },
            {
                    "field_cp_id": "5F71F714961AD19DAF8EF89B2A27B00F",
                    "values": {
                            "x": 22
                    }
            }
    ]
}

Reply

{
    "status": 200,
    "result": true,
    "params": {
        "cp_id": "5F71F6012A4B7030C01715028D88BDB8",
        "fields": [
            {
                "field_cp_id": "5F71F71459E493333429DFAF7ABC9576",
                "values": {
                    "x": 20,
                    "y": 30,
                    "witdh": 13.97,
                    "height": 3.11,
                    "value_pre": 8,
                    "page": 1,
                    "file_cp_id": "5F71CC6A71472280FF7004CF8130D72D",
                    "required": true,
                    "prefilled": true,
                    "show_only": false,
                    "text": "Budget"
                }
            },
            {
                "field_cp_id": "5F71F714961AD19DAF8EF89B2A27B00F",
                "values": {
                    "x": 22
                }
            }
        ]
    },
    "data": [
        {
            "x": 20,
            "y": 30,
            "width": 13.16,
            "height": 3.11,
            "page": 1,
            "file_cp_id": "5F71CC6A71472280FF7004CF8130D72D",
            "email": "user1@cloudplan.net",
            "display_type": "integer",
            "cp_id": "5F71F71459E493333429DFAF7ABC9576",
            "step": 0,
            "required": true,
            "prefilled": true,
            "show_only": false,
            "title": "New title",
            "text": "Budget",
            "value_pre": 8,
            "fontsize": 2,
            "background_color": "transparent",
            "border_show": false,
            "title_show": true
        },
        {
            "x": 22,
            "y": 21.27,
            "width": 16.7,
            "height": 3.34,
            "page": "1",
            "file_cp_id": "5F71CC6A71472280FF7004CF8130D72D",
            "email": "user1@cloudplan.net",
            "display_type": "signature",
            "cp_id": "5F71F714961AD19DAF8EF89B2A27B00F",
            "step": 0,
            "dateformat": "Y-m-d",
            "required": true,
            "prefilled": true,
            "show_only": false,
            "title": "Unterschrift",
            "background_color": "transparent",
            "border_show": false,
            "title_show": true
        }
    ]
}

Error Codes

workflow_not_found
workflow_not_owned
workflow_not_a_draft
not_fields_provided
field_not_found
invalid_values
invalid_field_cp_id
invalid_page
out_of_boundaries
not_a_number
not_allowed_value_pre_for_signatures
select_value_invalid
select_tag_not_found
invalid_cp_id