---
title: "PUT /v2/intention/{intentionId}"
method: PUT
path: "/v2/intention/{intentionId}"
---

# PUT /v2/intention/{intentionId}

`PUT /v2/intention/{intentionId}`

Atualiza os dados de uma intenção

## Path parameters

- `intentionId` string, required

## Request body

- Intention
  - `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[]
    - `name` string — Nome do campo
    - `jsonName` string — Nome JSON do campo
    - `description` string — Descrição do campo
    - `type` 'STRING' | 'URL' | 'DATE_TIME' | 'DATE' | 'NUMBER' | 'BOOLEAN' — Tipo do campo
    - `required` boolean — Campo obrigatório
  - `type` 'WEBHOOK' — Tipo de intenção
  - `httpMethod` 'GET' | 'POST' — Método HTTP
  - `url` string — URL do webhook
  - `headers` object[]
    - `name` string — Nome do cabeçalho
    - `value` string — Valor do cabeçalho
  - `params` object[]
    - `name` string — Nome do parâmetro
    - `value` string — Valor do parâmetro
  - `variables` object[]
    - `valueExpression` string, required — Expressão do valor a ser adicionado no campo padrão ou customizado
    - `defaultFieldKey` string — Nome do campo padrão. Aceitos são: chat_id, contact_name, contact_phone, contact_email, contact_gender, contact_birthday, contact_job_title, contact_org_name, contact_org_state, contact_org_city
    - `customField` object — Caso não seja um campo padrão informado em defaultFieldKey, informe o customField obtido em Listar campos.
      - `id` string — Id do campo a ser atualizado
      - `name` string — Nome do campo
      - `description` string — descrição do campo
      - `type` 'STRING' | 'DATE' | 'DATE_TIME' | 'NUMBER' | 'BOOLEAN' | 'MONEY'
      - `jsonName` string — nome do arquivo JSON
  - `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 `200`

Intenção atualizada com sucesso

- object
  - `success` boolean

## Other responses

- `400` — Erro inesperado
- `403` — Erro de token

---

[API](https://skmtc.net/gptmaker/apis/openapi-gpt-maker.md) · [All operations](https://skmtc.net/gptmaker/apis/openapi-gpt-maker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gptmaker/openapi-gpt-maker/versions/bda09b3eba6e/schema)