POST
/
v2
/
functions
/
{owner_name}
/
{function_name}
/
edit

Authorizations

X-API-Key
string
headerrequired

The Sieve API key to authenticate with.

Path Parameters

owner_name
string
required

The owner of the function.

function_name
string
required

The name of the function.

Body

application/json
webhooks
object | null

Webhooks to subscribe to for the function.

visibility
enum<string> | null

Whether the function is public or private.

Available options:
public,
private
title
string | null

Title of function.

code_url
string | null

URL of the function's code.

description
string | null

Description of the function.

tags
string[] | null

Tags associated with the function.

cover_image_url
string | null

URL pointing to an icon for the function.

readme
string | null

README content for the function.

examples
string[] | null

Example job ids.

Response

200 - application/json
name
string
required

The name of the function.

owner_name
string
required

The owner name of the function

title
string | null

The title of the function. Omitted if truncate enabled.

code_url
string | null

The link to the code of the function. Omitted if truncate enabled.

description
string | null

The description of the function. Omitted if truncate enabled.

tags
string[] | null

The tags of the function. Omitted if truncate enabled.

cover_image_url
string | null

The url of the function's cover image. Omitted if truncate enabled.

examples
string[] | null

An array of job ids that the function playground will use as an example. Omitted if truncate enabled.

readme
string | null

The readme of the function. Omitted if truncate enabled.

latest_version
object | null

The latest version of the function. Omitted if truncate enabled.

function_type
enum<string> | null

The type of the function, either a simple function or a workflow. Omitted if truncate enabled.

Available options:
function,
workflow
webhooks
object[] | null

The webhooks associated with the function. Omitted if truncate enabled.

restart_on_error
boolean | null

Whether to restart the function on job error. Omitted if truncate enabled.