_setName

Sets the name of a Form Block.

Parameters

id

The ID of the Form Block to be modified.

name

The name which will be set to the Form Block.

Example

FM_api('FormBlock_setName', [
        'id' => '12345',
        'name' => 'new name'
    ]
);

Results

On Success

{"ok":1}

If the Form Block being modified already has the name set to the "name" parameter's value.

{"ok":1,"warning":"no change needed"}

On Failure

If the "id" parameter is not set or has a value less than 1:

{"error":"missing or invalid parameter: id"}

If the "name" parameter is not set or has an empty string after being trimmed:

{"error":"missing or invalid parameter: name"}

If the "id" parameter does not match the ID of an existing Form Block:

{"error":"no such form block"}

If the "name" parameter has a string longer than 64 characters after being trimmed:

{"error":"parameter too long: name"}

If a different Form Block with the same name as the "name" parameter already exists:

{"error":"A form or email block with that name already exists"}