Atualizar processo

Atualiza informações de um processo de assinatura existente.

PATCH /api/signature-processes/{signature_process}

Atualizar processo

cURL

curl --request PATCH \
  --url https://api.valid.com/api/signature-processes/{signature_process} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "code": "<string>",
  "options": {
    "url_origin": "<string>",
    "url_notification": "<string>",
    "due_date": "<string>",
    "finish-message-text": "<string>",
    "period_renotify": 123,
    "max_renotify": 123
  }
}
'

import requests

url = "https://api.valid.com/api/signature-processes/{signature_process}"

payload = {
    "title": "<string>",
    "code": "<string>",
    "options": {
        "url_origin": "<string>",
        "url_notification": "<string>",
        "due_date": "<string>",
        "finish-message-text": "<string>",
        "period_renotify": 123,
        "max_renotify": 123
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    code: '<string>',
    options: {
      url_origin: '<string>',
      url_notification: '<string>',
      due_date: '<string>',
      'finish-message-text': '<string>',
      period_renotify: 123,
      max_renotify: 123
    }
  })
};

fetch('https://api.valid.com/api/signature-processes/{signature_process}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valid.com/api/signature-processes/{signature_process}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'code' => '<string>',
    'options' => [
        'url_origin' => '<string>',
        'url_notification' => '<string>',
        'due_date' => '<string>',
        'finish-message-text' => '<string>',
        'period_renotify' => 123,
        'max_renotify' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/api/signature-processes/{signature_process}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"code\": \"<string>\",\n  \"options\": {\n    \"url_origin\": \"<string>\",\n    \"url_notification\": \"<string>\",\n    \"due_date\": \"<string>\",\n    \"finish-message-text\": \"<string>\",\n    \"period_renotify\": 123,\n    \"max_renotify\": 123\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.valid.com/api/signature-processes/{signature_process}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"code\": \"<string>\",\n  \"options\": {\n    \"url_origin\": \"<string>\",\n    \"url_notification\": \"<string>\",\n    \"due_date\": \"<string>\",\n    \"finish-message-text\": \"<string>\",\n    \"period_renotify\": 123,\n    \"max_renotify\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/api/signature-processes/{signature_process}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"code\": \"<string>\",\n  \"options\": {\n    \"url_origin\": \"<string>\",\n    \"url_notification\": \"<string>\",\n    \"due_date\": \"<string>\",\n    \"finish-message-text\": \"<string>\",\n    \"period_renotify\": 123,\n    \"max_renotify\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

200 OK

{
  "message": "Processo de assinatura atualizado com sucesso.",
  "uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
  "code": "PRC-2023-001-V2"
}

Parâmetros de Path

signature_process · string · required

UUID do processo de assinatura. Exemplo: 8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d

Body

title · string · required

Título do processo atualizado. Exemplo: Novo título atualizado

code · string · required

Novo código (ou o mesmo). Exemplo: PRC-001-ATUALIZADO

options · object

Opções a atualizar.

Show Opções

url_origin · string

URL de origem. Exemplo: https://cliente.com.br

url_notification · string

URL de webhook. Exemplo: https://cliente.com.br/webhook

due_date · string

Data de vencimento. Exemplo: 2025-07-01

finish-message-text · string

Mensagem de conclusão. Exemplo: Obrigado por assinar.

period_renotify · integer

Período de renotificação. Exemplo: 3

max_renotify · integer

Máximo de renotificações. Exemplo: 5

Resposta

message · string

Mensagem de sucesso.

uuid · string

UUID do processo.

code · string

Código do processo.

200 OK

{
  "message": "Processo de assinatura atualizado com sucesso.",
  "uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
  "code": "PRC-2023-001-V2"
}