Atualizar lote de assinatura

curl --request PATCH \
  --url https://api.juridiq.com.br/signature/batch/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "isPrivate": true
}
'

import requests

url = "https://api.juridiq.com.br/signature/batch/{id}"

payload = {
    "name": "<string>",
    "isPrivate": True
}
headers = {
    "x-juridiq-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-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', isPrivate: true})
};

fetch('https://api.juridiq.com.br/signature/batch/{id}', 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.juridiq.com.br/signature/batch/{id}",
  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([
    'name' => '<string>',
    'isPrivate' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-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.juridiq.com.br/signature/batch/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"isPrivate\": true\n}")

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

	req.Header.Add("x-juridiq-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.juridiq.com.br/signature/batch/{id}")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"isPrivate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/signature/batch/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"isPrivate\": true\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "plugsignLoteId": "<string>",
  "status": "<string>",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "signatories": "<unknown>",
  "responsibleId": "<string>",
  "isPrivate": true,
  "expireDate": "2023-11-07T05:31:56Z",
  "responsible": {
    "id": "<string>",
    "name": "<string>",
    "imageUrl": "<string>"
  },
  "personOnBatches": "<unknown>",
  "signatures": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "documentName": "<string>",
      "documentKey": "<string>",
      "status": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "signName": "<string>",
      "signingKey": "<string>",
      "signatories": [
        {
          "contact": "<string>",
          "signed": true,
          "url": "<string>"
        }
      ],
      "responsibleId": "<string>",
      "responsible": {
        "id": "<string>",
        "name": "<string>",
        "imageUrl": "<string>"
      },
      "isPrivate": true,
      "personOnSignatures": "<unknown>",
      "history": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

PATCH

signature

batch

{id}

Atualizar lote de assinatura

curl --request PATCH \
  --url https://api.juridiq.com.br/signature/batch/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "isPrivate": true
}
'

import requests

url = "https://api.juridiq.com.br/signature/batch/{id}"

payload = {
    "name": "<string>",
    "isPrivate": True
}
headers = {
    "x-juridiq-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-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', isPrivate: true})
};

fetch('https://api.juridiq.com.br/signature/batch/{id}', 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.juridiq.com.br/signature/batch/{id}",
  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([
    'name' => '<string>',
    'isPrivate' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-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.juridiq.com.br/signature/batch/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"isPrivate\": true\n}")

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

	req.Header.Add("x-juridiq-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.juridiq.com.br/signature/batch/{id}")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"isPrivate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/signature/batch/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"isPrivate\": true\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "plugsignLoteId": "<string>",
  "status": "<string>",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "signatories": "<unknown>",
  "responsibleId": "<string>",
  "isPrivate": true,
  "expireDate": "2023-11-07T05:31:56Z",
  "responsible": {
    "id": "<string>",
    "name": "<string>",
    "imageUrl": "<string>"
  },
  "personOnBatches": "<unknown>",
  "signatures": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "documentName": "<string>",
      "documentKey": "<string>",
      "status": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "signName": "<string>",
      "signingKey": "<string>",
      "signatories": [
        {
          "contact": "<string>",
          "signed": true,
          "url": "<string>"
        }
      ],
      "responsibleId": "<string>",
      "responsible": {
        "id": "<string>",
        "name": "<string>",
        "imageUrl": "<string>"
      },
      "isPrivate": true,
      "personOnSignatures": "<unknown>",
      "history": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key.

Path Parameters

string<uuid>

required

ID do lote

Body

application/json

name

string

Nome do lote

Minimum string length: 1

isPrivate

boolean

Lote privado

Response

Default Response

string<uuid>

required

ID do lote

name

string

required

Nome do lote

plugsignLoteId

string

required

ID do lote no PlugSign

status

string

required

Status do lote

officeId

string<uuid>

required

ID do escritório

createdAt

required

Criado em

updatedAt

required

Atualizado em

signatories

any

Signatários do lote

responsibleId

string | null

ID do responsável

isPrivate

boolean | null

Lote privado

expireDate

Data de expiração

responsible

object | null

Show child attributes

personOnBatches

any

Pessoas vinculadas ao lote

signatures

object[]

Documentos do lote

Show child attributes

Primeiros Passos

API Reference

Atualizar lote de assinatura

Authorizations

Path Parameters

Body

Response