Skip to main content
PATCH
/
api
/
v1
/
user-defined-functions
UpdateUserDefinedFunction
curl --request PATCH \
  --url https://your-sift-api-url.com/api/v1/user-defined-functions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "userDefinedFunction": {
    "userDefinedFunctionId": "<string>",
    "name": "<string>",
    "archivedDate": "2023-11-07T05:31:56Z",
    "userDefinedFunctionVersionId": "<string>",
    "version": 123,
    "description": "<string>",
    "changeMessage": "<string>",
    "userNotes": "<string>",
    "expression": "<string>",
    "functionInputs": [
      {
        "identifier": "<string>",
        "dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
        "constant": true
      }
    ],
    "functionOutputType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
    "functionDependencies": [
      {
        "userDefinedFunctionVersionId": "<string>"
      }
    ],
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "updateMask": "<string>"
}'
{
  "userDefinedFunction": {
    "userDefinedFunctionId": "<string>",
    "name": "<string>",
    "archivedDate": "2023-11-07T05:31:56Z",
    "userDefinedFunctionVersionId": "<string>",
    "version": 123,
    "description": "<string>",
    "changeMessage": "<string>",
    "userNotes": "<string>",
    "expression": "<string>",
    "functionInputs": [
      {
        "identifier": "<string>",
        "dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
        "constant": true
      }
    ],
    "functionOutputType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
    "functionDependencies": [
      {
        "userDefinedFunctionVersionId": "<string>"
      }
    ],
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to UserDefinedFunctionService_UpdateUserDefinedFunction to update a user defined function. Updating a user defined function creates a new version of the user defined function, leaving the previous untouched. If no update is deemed necessary, then the the current version is returned. If name is changed then only name will be changed. If archive date is changed then only archive date will be changed. To archive user defined function, specify archived_date in the update mask as well as a non-null value for archived_date in the user_defined_function object. To unarchive a user defined function, specify archived_date in the update mask and a null value for archived_date in the user_defined_function object.

​
userDefinedFunction
object
required
​
updateMask
string
required

The list of fields to be updated. The fields available to be updated are name, archived_date, description, expression, and function_inputs. -- name can't be updated if the function has ever had any dependencies -- function_inputs inputs can't be updated if the function has any dependents (functions or calculated channels with a dependency on this function). -- expression can't be updated if the function has dependents and the expression changes the output type.

Response

A successful response.

​
userDefinedFunction
object
required