API ReferenceFunctions

/public/functions/{functionId}

Replace a function

PUT
/public/functions/{functionId}

Replace a function

Path Parameters

functionId*string

Header Parameters

X-API-Version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

application/json

application/json

curl -X PUT "https://companion-api.napster.com/public/functions/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "data": {
    "name": "string",
    "description": "string",
    "parameters": {
      "type": "string",
      "description": "string",
      "properties": {
        "property1": null,
        "property2": null
      },
      "required": [
        "string"
      ]
    }
  },
  "flow": "implicit",
  "url": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "receiveMessages": true,
  "prompt": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "connectionBehavior": {
    "waitBeforeStart": true,
    "abortOnFailure": true
  }
}
[
  {
    "code": "string",
    "description": "string",
    "type": "failure",
    "numericType": 0
  }
]
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}
{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}
{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}