Skip to main content
PUT
/
api
/
v1
/
endpoints
/
{endpoint_id}
Update Endpoint
curl --request PUT \
  --url https://api.example.com/api/v1/endpoints/{endpoint_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "path": "<string>",
  "auth_required": true,
  "condition": "<string>",
  "actions": [
    {}
  ],
  "response_template": {},
  "enabled": true
}
'
{
  "id": "<string>",
  "account_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "path": "<string>",
  "method": "<string>",
  "auth_required": true,
  "condition": "<string>",
  "actions": [
    {}
  ],
  "response_template": {},
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.snackbase.dev/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
endpoint_id
string
required

Body

application/json

Request body for updating a custom endpoint (all fields optional).

​
name
string | null
Required string length: 1 - 200
​
description
string | null
​
path
string | null
​
method
enum<string> | null
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
​
auth_required
boolean | null
​
condition
string | null

Pass '' to clear the condition expression

​
actions
Actions · object[] | null
​
response_template
Response Template · object
​
enabled
boolean | null

Response

Successful Response

Response schema for a single custom endpoint.

​
id
string
required
​
account_id
string
required
​
name
string
required
​
description
string | null
required
​
path
string
required
​
method
string
required
​
auth_required
boolean
required
​
condition
string | null
required
​
actions
Actions · object[]
required
​
response_template
Response Template · object
required
​
enabled
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
created_by
string | null
required