Skip to main content
PUT
/
custom-components
/
{customComponentId}
Update a custom component.
curl --request PUT \
  --url https://api.gleap.io/v3/custom-components/{customComponentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'project: <project>' \
  --data '
{
  "name": "<string>",
  "schema": "<unknown>",
  "template": "<string>",
  "description": "<string>",
  "whenToUse": "<string>",
  "exampleData": "<unknown>",
  "isPublished": true
}
'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "isPublished": true,
  "exampleData": "<unknown>",
  "sanitizedTemplate": "<string>",
  "template": "<string>",
  "whenToUse": "<string>",
  "project": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "description": "<string>",
  "name": "<string>",
  "schema": "<unknown>",
  "createdBy": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gleap.io/llms.txt

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

Authorizations

​
Authorization
string
header
required

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

Headers

​
project
string
required

Path Parameters

​
customComponentId
string
required

Body

application/json
​
name
string
required
​
schema
any
required
​
template
string
required
​
description
string
​
whenToUse
string
​
exampleData
any
​
isPublished
boolean

Response

200 - application/json

Ok

Generic types for Document:

  • T - the type of _id
  • TQueryHelpers - Object with any helpers that should be mixed into the Query type
  • DocType - the type of the actual Document created
​
updatedAt
string
required
​
createdAt
string
required
​
isPublished
boolean
required
​
exampleData
any
required
​
sanitizedTemplate
string
required
​
template
string
required
​
whenToUse
string
required
​
project
object
required
​
description
string
required
​
name
string
required
​
schema
any
required
​
createdBy
string