PATCH
/
api
/
v1
/
external-functions
/
{functionId}

Updates the properties of the external function with the specified ID.

Authorizations

​
AUTHORIZATION
string
header
required

API key required for this endpoint. Use Bearer YOUR_SECRET_API_KEY. Get your key from https://play.ai/developers.

​
X-USER-ID
string
header
required

User ID required for this endpoint. Get it from https://play.ai/developers.

Headers

​
content-type
enum<string>
required
Available options:
application/json
​
accept
enum<string>
Available options:
application/json

Path Parameters

​
functionId
string
required

The external function's ID.

Body

application/json
​
description
any
​
endpointUrl
any
​
method
any
​
name
any
​
parameters
any

Response

200 - application/json
​
description
string

The external function's description

Maximum length: 500
​
endpointUrl
string

The external function's endpoint URL

Maximum length: 500
​
id
string

The unique ID for each external function.

​
method
enum<string>
default:
GET

The external function's method

Available options:
POST,
GET,
PUT,
DELETE
​
name
string

The external function's name

Maximum length: 250
​
parameters
object[]