---
title: "Atualiza contexto, expires_at ou callback_url do run"
method: PUT
path: "/api/v1/versions/{version_key}/runs/{run_key}"
tags: ["Runs"]
---

# Atualiza contexto, expires_at ou callback_url do run

`PUT /api/v1/versions/{version_key}/runs/{run_key}`

## Request

- Base URL: `https://clickform-sandbox.clicksign.com`
- URL: `https://clickform-sandbox.clicksign.com/api/v1/versions/{version_key}/runs/{run_key}`
- Auth: API key in header `Authorization`

Run com `status: done` não pode ser alterado (409). Se o run não possuir `access_verification` e a atualização passar a incluir esse objeto,o `status` passa para `access_verification_required`.

## Path parameters

- `version_key` string, uuid, required
- `run_key` string, uuid, required

## Request body

- object
  - `context` object, required
  - `expires_at` string, date-time
  - `callback_url` string, uri: Opcional; omitir mantém o valor atual; string vazia remove o callback deste run.
  - `access_verification` object: Etapa opcional de verificação para liberar o acesso ao formulário da execução.
    - `label` string, required: Mensagem exibida ao usuário final antes da validação do valor.
    - `expected_value` string, required: Valor de comparação esperado para liberar o acesso.
    - `mask_percentage` integer: Percentual do expected_value que deve ser mascarado na exibição. Quando omitido em access_verification, a API aplica default 90.

## Response `200`

Run atualizado.

- object: Execução (RUN) com dados persistidos e URL pública para preenchimento.
  - `key` string, uuid
  - `status` 'pending' | 'done' | 'access_verification_required'
  - `context` object
  - `responses` object
  - `expires_at` string, date-time
  - `callback_url` string, uri: Webhook opcional desta execução (disparado na conclusão, junto com a callback do formulário quando configurada).
  - `access_verification` object: Etapa opcional de verificação para liberar o acesso ao formulário da execução.
    - `label` string, required: Mensagem exibida ao usuário final antes da validação do valor.
    - `expected_value` string, required: Valor de comparação esperado para liberar o acesso.
    - `mask_percentage` integer: Percentual do expected_value que deve ser mascarado na exibição. Quando omitido em access_verification, a API aplica default 90.
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `form_url` string, uri: URL única do preenchimento do formulário (inclui o contexto do run nas respostas).

## Other responses

- `400`: Requisição inválida.
- `401`: Autenticação ausente ou inválida.
- `404`: Recurso não encontrado.
- `409`: Run já finalizado (não pode ser modificado).

---

[API](https://skmtc.dev/clicksign/apis/m-dulo-de-coleta-de-dados-clickform.md) - [All operations](https://skmtc.dev/clicksign/apis/m-dulo-de-coleta-de-dados-clickform/llms.txt) - [OpenAPI document](https://skmtc.dev/clicksign/apis/m-dulo-de-coleta-de-dados-clickform/revisions/05dba4170672?raw)
