Update an organization seal

curl --request PATCH \
  --url https://api.firma.dev/functions/v1/signing-request-api/seals/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "signatory_title": "<string>",
  "image": "<string>",
  "typed": {
    "text": "<string>",
    "style": "<string>"
  },
  "is_default": true
}
'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/seals/{id}"

payload = {
    "name": "<string>",
    "display_name": "<string>",
    "signatory_title": "<string>",
    "image": "<string>",
    "typed": {
        "text": "<string>",
        "style": "<string>"
    },
    "is_default": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    display_name: '<string>',
    signatory_title: '<string>',
    image: '<string>',
    typed: {text: '<string>', style: '<string>'},
    is_default: true
  })
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/seals/{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.firma.dev/functions/v1/signing-request-api/seals/{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>',
    'display_name' => '<string>',
    'signatory_title' => '<string>',
    'image' => '<string>',
    'typed' => [
        'text' => '<string>',
        'style' => '<string>'
    ],
    'is_default' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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.firma.dev/functions/v1/signing-request-api/seals/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"signatory_title\": \"<string>\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": true\n}")

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

	req.Header.Add("Authorization", "<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.firma.dev/functions/v1/signing-request-api/seals/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"signatory_title\": \"<string>\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/seals/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"signatory_title\": \"<string>\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": true\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": 2,
  "companies_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companies_workspaces_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authority_name": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "signatory_title": "<string>",
  "kind": "uploaded",
  "is_default": 0,
  "statement_language": "<string>",
  "statement_version": 2,
  "statement_text": "<string>",
  "statement_hash": "<string>",
  "signatory_name": "<string>",
  "signatory_title_attested": "<string>",
  "attested_at": "2023-11-07T05:31:56Z",
  "revoked_on": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted": 0
}

{
  "error": "Validation Error",
  "message": "Invalid input data",
  "details": {
    "name": "Name is required",
    "email": "Invalid email format"
  }
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found"
}

{
  "error": "<string>",
  "code": "SEALS_DISABLED"
}

{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

Seals

Update an organization seal

Update a seal’s name, display name, image, or default status. Any image-class change (image, typed, display_name, signatory_title, statement) creates a new version (replace) and requires a statement with accepted true, version 1, language, text equal to the seal’s statement_text exactly, signatory_name, and optional signatory_title; otherwise the request fails with 400 SEAL_STATEMENT_REQUIRED. The new version records this request’s acceptance: signatory_name and signatory_title_attested are the signatory sent, and attested_at is the replacement time. Requests already sent keep the version pinned when they were sent; requests sent after the replacement use the new version, and their certificates show the new signatory. The statement text never changes. Company-scope seals require a protected API key for mutations.

PATCH

seals

{id}

curl --request PATCH \
  --url https://api.firma.dev/functions/v1/signing-request-api/seals/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "signatory_title": "<string>",
  "image": "<string>",
  "typed": {
    "text": "<string>",
    "style": "<string>"
  },
  "is_default": true
}
'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/seals/{id}"

payload = {
    "name": "<string>",
    "display_name": "<string>",
    "signatory_title": "<string>",
    "image": "<string>",
    "typed": {
        "text": "<string>",
        "style": "<string>"
    },
    "is_default": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    display_name: '<string>',
    signatory_title: '<string>',
    image: '<string>',
    typed: {text: '<string>', style: '<string>'},
    is_default: true
  })
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/seals/{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.firma.dev/functions/v1/signing-request-api/seals/{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>',
    'display_name' => '<string>',
    'signatory_title' => '<string>',
    'image' => '<string>',
    'typed' => [
        'text' => '<string>',
        'style' => '<string>'
    ],
    'is_default' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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.firma.dev/functions/v1/signing-request-api/seals/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"signatory_title\": \"<string>\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": true\n}")

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

	req.Header.Add("Authorization", "<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.firma.dev/functions/v1/signing-request-api/seals/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"signatory_title\": \"<string>\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/seals/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"signatory_title\": \"<string>\",\n  \"image\": \"<string>\",\n  \"typed\": {\n    \"text\": \"<string>\",\n    \"style\": \"<string>\"\n  },\n  \"is_default\": true\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": 2,
  "companies_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companies_workspaces_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authority_name": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "signatory_title": "<string>",
  "kind": "uploaded",
  "is_default": 0,
  "statement_language": "<string>",
  "statement_version": 2,
  "statement_text": "<string>",
  "statement_hash": "<string>",
  "signatory_name": "<string>",
  "signatory_title_attested": "<string>",
  "attested_at": "2023-11-07T05:31:56Z",
  "revoked_on": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted": 0
}

{
  "error": "Validation Error",
  "message": "Invalid input data",
  "details": {
    "name": "Name is required",
    "email": "Invalid email format"
  }
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found"
}

{
  "error": "<string>",
  "code": "SEALS_DISABLED"
}

{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

string<uuid>

required

Seal ID

Body

application/json

name

string

New internal name

Maximum string length: 120

display_name

string

New display name (triggers image re-render)

Maximum string length: 200

signatory_title

string | null

New signatory title

Maximum string length: 200

image

string

New base64 PNG data URI

typed

object

Show child attributes

statement

object

Attestation statement affirming authority to apply the seal.

Show child attributes

is_default

boolean

Set as default seal for its scope

Response

Seal updated successfully

Organization seal metadata (image and statement internals are stripped from list/get responses).

string<uuid>

lineage_id

string<uuid>

Shared across versions of the same seal

version

integer

Required range: x >= 1

companies_id

string<uuid>

companies_workspaces_id

string<uuid> | null

Null for company-scope seals

authority_name

string | null

The name the seal was attested for: the company for company scope or the protected workspace, otherwise the workspace. Null for seals whose lineage was created before pinning; they certify in the company's current name.

name

string

Maximum string length: 120

display_name

string

Maximum string length: 200

signatory_title

string | null

Maximum string length: 200

kind

enum<string>

Available options:

uploaded,

typed,

drawn

is_default

enum<integer>

1 if this is the default seal for its scope

Available options:

0,

1

statement_language

string

statement_version

integer

Required range: x >= 1

statement_text

string

The authority statement the seal was attested under, stored verbatim. Write-once: it never changes across versions of a lineage.

statement_hash

string

SHA-256 of statement_text (UTF-8), lowercase hex.

signatory_name

string

Maximum string length: 200

signatory_title_attested

string | null

Maximum string length: 200

attested_at

string<date-time>

revoked_on

string<date-time> | null

created_at

string<date-time>

deleted

enum<integer>

Available options:

0,

1