CLclicksign
Runs

Atualiza contexto, expires_at ou callback_url do run

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.

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

Path parameters

version_keystring uuid required

UUID da versão do schema.

run_keystring uuid required

UUID da execução (run).

Request body

contextobject required
expires_atstring date-time
callback_urlstring uri

Opcional; omitir mantém o valor atual; string vazia remove o callback deste run.

Response

Run atualizado.

keystring uuid
status'pending' | 'done' | 'access_verification_required'
contextobject
responsesobject
expires_atstring date-time
callback_urlstring uri

Webhook opcional desta execução (disparado na conclusão, junto com a callback do formulário quando configurada).

created_atstring date-time
updated_atstring date-time
form_urlstring uri

URL única do preenchimento do formulário (inclui o contexto do run nas respostas).

Changes

No recorded changes to this operation across all 1 revision of this API.