Agenda de Signatários
Atualizar grupo de signatários
Edita o nome e a lista de membros de um grupo (substitui completamente).
PUT
/
signer
/
v1
/
signer-contact-groups
/
:uuid
Atualizar grupo de signatários
curl --request PUT \
--url https://api.valid.com/signer/v1/signer-contact-groups/:uuid \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"contactUuids": [
{}
]
}
'import requests
url = "https://api.valid.com/signer/v1/signer-contact-groups/:uuid"
payload = {
"name": "<string>",
"contactUuids": [{}]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', contactUuids: [{}]})
};
fetch('https://api.valid.com/signer/v1/signer-contact-groups/:uuid', 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/signer/v1/signer-contact-groups/:uuid",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'contactUuids' => [
[
]
]
]),
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/signer/v1/signer-contact-groups/:uuid"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"contactUuids\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.valid.com/signer/v1/signer-contact-groups/:uuid")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"contactUuids\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/signer/v1/signer-contact-groups/:uuid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"contactUuids\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyHTTP/1.1 200 OK
Content-Type: application/json
{
"uuid": "6ba7b820-9dad-11d1-80b4-00c04fd430c9",
"name": "Diretoria Executiva",
"members": [
{
"uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "João Silva",
"cpf": "12345678901",
"email": "joao@empresa.com"
}
],
"updatedAt": "2025-07-27T15:00:00Z"
}
Atualiza um grupo de signatários, substituindo completamente o nome e a lista de membros. A operação é “tudo ou nada” — a lista inteira de contatos é refeita.
Autenticação:
x-api-key no header. Também aceita Authorization: Bearer.
Parâmetros
string
required
UUID do grupo.
string
required
Novo nome do grupo.
array
required
Nova lista de contatos (substitui completamente a anterior). Mínimo 1.
Respostas
Retorna o objeto do grupo atualizado.Erros
Veja Autenticação e erros.- 400: Lista vazia, ou contato não pertence à agenda.
- 404: Grupo não encontrado ou não pertence ao seu projeto.
- 409: Novo nome já existe em outro grupo.
HTTP/1.1 200 OK
Content-Type: application/json
{
"uuid": "6ba7b820-9dad-11d1-80b4-00c04fd430c9",
"name": "Diretoria Executiva",
"members": [
{
"uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "João Silva",
"cpf": "12345678901",
"email": "joao@empresa.com"
}
],
"updatedAt": "2025-07-27T15:00:00Z"
}
Exemplo
curl -X PUT "https://api.valid.com/signer/v1/signer-contact-groups/6ba7b820-9dad-11d1-80b4-00c04fd430c9" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Diretoria Executiva",
"contactUuids": [
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
}'
Importante
- Substitui completamente: a lista anterior é descartada, use a nova lista.
- Soft-delete de membros: os membros removidos são marcados como deletados no banco (não aparecem mais nas buscas), mas históricos são preservados.
Relacionado
GET .../signer-contact-groups— listar gruposDELETE .../signer-contact-groups/:uuid— remover grupo
⌘I
Atualizar grupo de signatários
curl --request PUT \
--url https://api.valid.com/signer/v1/signer-contact-groups/:uuid \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"contactUuids": [
{}
]
}
'import requests
url = "https://api.valid.com/signer/v1/signer-contact-groups/:uuid"
payload = {
"name": "<string>",
"contactUuids": [{}]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', contactUuids: [{}]})
};
fetch('https://api.valid.com/signer/v1/signer-contact-groups/:uuid', 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/signer/v1/signer-contact-groups/:uuid",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'contactUuids' => [
[
]
]
]),
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/signer/v1/signer-contact-groups/:uuid"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"contactUuids\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.valid.com/signer/v1/signer-contact-groups/:uuid")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"contactUuids\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/signer/v1/signer-contact-groups/:uuid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"contactUuids\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyHTTP/1.1 200 OK
Content-Type: application/json
{
"uuid": "6ba7b820-9dad-11d1-80b4-00c04fd430c9",
"name": "Diretoria Executiva",
"members": [
{
"uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "João Silva",
"cpf": "12345678901",
"email": "joao@empresa.com"
}
],
"updatedAt": "2025-07-27T15:00:00Z"
}