[comment]: # ({2ed6e81f-2ed6e81f})
# usermacro.update

[comment]: # ({/2ed6e81f-2ed6e81f})

[comment]: # ({5b5e06a2-23e3a148})
### Description

`object usermacro.update(object/array hostMacros)`

This method allows to update existing host macros.

[comment]: # ({/5b5e06a2-23e3a148})

[comment]: # ({f8ce947c-f8ce947c})
### Parameters

`(object/array)` [Host macro properties](object#host_macro) to be
updated.

The `hostmacroid` property must be defined for each host macro, all
other properties are optional. Only the passed properties will be
updated, all others will remain unchanged.

[comment]: # ({/f8ce947c-f8ce947c})

[comment]: # ({5e19fc38-5e19fc38})
### Return values

`(object)` Returns an object containing the IDs of the updated host
macros under the `hostmacroids` property.

[comment]: # ({/5e19fc38-5e19fc38})

[comment]: # ({b41637d2-b41637d2})
### Examples

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({bc8ce678-bc8ce678})
#### Changing the value of a host macro

Change the value of a host macro to "public".

Request:

``` {.java}
{
    "jsonrpc": "2.0",
    "method": "usermacro.update",
    "params": {
        "hostmacroid": "1",
        "value": "public"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

``` {.java}
{
    "jsonrpc": "2.0",
    "result": {
        "hostmacroids": [
            "1"
        ]
    },
    "id": 1
}
```

[comment]: # ({/bc8ce678-bc8ce678})

[comment]: # ({e919b070-2eddd7d2})
### Source

CUserMacro::update() in
*frontends/php/include/classes/api/services/CUserMacro.php*.

[comment]: # ({/e919b070-2eddd7d2})