Skip to main content
PUT
/
v2
/
intention
/
{intentionId}
cURL
curl --request PUT \
  --url https://api.gptmaker.ai/v2/intention/{intentionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "details": "<string>",
  "fields": [
    {
      "name": "<string>",
      "jsonName": "<string>",
      "description": "<string>",
      "type": "STRING",
      "required": true
    }
  ],
  "type": "WEBHOOK",
  "httpMethod": "GET",
  "url": "<string>",
  "headers": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "params": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "variables": [
    {
      "valueExpression": "<string>",
      "defaultFieldKey": "<string>",
      "customField": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "type": "STRING",
        "jsonName": "<string>"
      }
    }
  ],
  "requestBody": "<string>",
  "autoGenerateParams": true,
  "autoGenerateBody": true
}'
{
  "success": true
}

Authorizations

Authorization
string
header
required

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

Path Parameters

intentionId
string
required

ID da intenção

Body

application/json

Dados da intenção a ser atualizada

id
string

ID da intenção

description
string

Descrição da intenção

instructions
string

Quando usar a intenção

details
string

Instruções dos dados de saída

fields
object[]
type
enum<string>

Tipo de intenção

Available options:
WEBHOOK
httpMethod
enum<string>

Método HTTP

Available options:
GET,
POST
url
string

URL do webhook

headers
object[]
params
object[]
variables
object[]
requestBody
string

String contendo um JSON que será enviado no corpo da requisição

autoGenerateParams
boolean

Geração automática de parâmetros

autoGenerateBody
boolean

Geração automática do corpo da requisição

Response

Intenção atualizada com sucesso

success
boolean
I