Sign in
functions

Update a Function

Update a Function.

put/groups/{groupId}/apps/{appId}/functions/{functionId}

Response

The function was successfully updated.

can_evaluateobject

A JSON expression that evaluates to true if the Function is allowed to run in response to an incoming request.

namestring required

A unique name for the Function.

privateboolean required

If true, the function is hidden from client applications. You can still call a private function from JSON expressions and other functions, including incoming webhooks and triggers.

sourcestring required

The stringified source code for the function. The code must be valid ES6.

run_as_systemboolean

If true, the function executes with full privileges, bypassing rules on all services.

run_as_user_idstring

An application user's account ID. If defined, endpoints will always run as the specified user. Cannot be used with run_as_user_id_script_source.

run_as_user_id_script_sourcestring

The stringified source code for a function that returns an application user's account ID. If defined, endpoints execute the function on every request and run as the user with the ID returned from the function. Cannot be used with run_as_user_id.

Changes

Changed in 2 of the 50 revisions of this API.12

  • v3e2240dd053bd1See the full diff
    • ▲

      the response property run_as_system became optional for the status 200

      response-property-became-optional

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v30d26ece81dcc2See the full diff
    • ○

      added the optional property run_as_user_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property run_as_user_id_script_source to the response with the 200 status

      response-optional-property-added