Retract Office Vote

curl --request DELETE \
  --url https://api.signa.so/v1/offices/votes/{code} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.signa.so/v1/offices/votes/{code}', 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.signa.so/v1/offices/votes/{code}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.signa.so/v1/offices/votes/{code}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.signa.so/v1/offices/votes/{code}")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "object": "office_vote",
  "office_code": "BR",
  "deleted": true,
  "request_id": "req_01kabc..."
}

DELETE

offices

votes

{code}

Retract Office Vote

curl --request DELETE \
  --url https://api.signa.so/v1/offices/votes/{code} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.signa.so/v1/offices/votes/{code}', 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.signa.so/v1/offices/votes/{code}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.signa.so/v1/offices/votes/{code}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.signa.so/v1/offices/votes/{code}")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "object": "office_vote",
  "office_code": "BR",
  "deleted": true,
  "request_id": "req_01kabc..."
}

Overview

Removes your organization’s vote for one office. DELETE accepts a wider vocabulary than casting: any ST.3 / ISO 3166-1 two-letter code (plus BX, AP, OA, aliases canonicalized) resolves here. Only an unrecognizable token returns 400. Codes that casting rejects — an office Signa already covers, or a territory with no trademark register of its own (AQ, BV, …) — still resolve and still delete, so a row stored under an earlier vocabulary is never stranded; when you have no vote for the code, you get 404, not 400. A territory resolves to the office that registers its marks, so retracting PR targets the USPTO vote and RE the INPI-FR one — and because the code is canonicalized first, the 404 detail names the parent office (US, FR), not the territory you sent. Retracting is free — DELETE bills 0 units, as does casting; only List Office Votes bills (1 read unit). Responses carry the standard RateLimit-* headers. Requires an Idempotency-Key header: retrying with the same key replays the cached response of that attempt (so a replayed retract still reads deleted: true, not 404), while a new logical attempt — retracting again after re-casting the vote — needs a fresh key. The vote itself is stored once per organization per office, so the server’s state is the same either way.

Path Parameters

string

required

Office code — ST.3 / ISO, any case or accepted alias (UK retracts the GB vote).

Response

string

Always office_vote.

string

Canonical uppercase ST.3 code of the retracted vote.

boolean

Always true.

Returns 404 not_found when your organization has no vote for the office ("Your organization has no vote for BR."), and 400 validation_error for unknown codes.

{
  "object": "office_vote",
  "office_code": "BR",
  "deleted": true,
  "request_id": "req_01kabc..."
}

Code Examples

curl -X DELETE "https://api.signa.so/v1/offices/votes/BR" \
  -H "Authorization: Bearer sig_YOUR_KEY" \
  -H "Idempotency-Key: retract-office-vote-br-001"

import { Signa } from "@signa-so/sdk";

const signa = new Signa({ api_key: process.env.SIGNA_API_KEY });

const retracted = await signa.references.retractOfficeVote("BR");
console.log(retracted.office_code, retracted.deleted); // BR true

Errors

Status	Type	Description
400	`validation_error`	`unknown_office_code` — the only vocabulary rejection on retract. Covered offices and register-less codes (`AQ`, `BV`, …) resolve normally and delete
400	`validation_error`	Missing `Idempotency-Key` header
401	`unauthorized`	Missing or invalid API key
404	`not_found`	Your organization has no vote for this office
409	`conflict`	`Idempotency-Key` reused with a different body
409	`idempotency_processing`	A request with the same `Idempotency-Key` is still in flight
429	`rate_limited`	Too many requests

The 404 detail reads "Your organization has no vote for BR." — the code is canonicalized first, so retracting uk when you have no GB vote reports GB, and retracting PR reports US.

Cast Office Votes, vote for the offices you want next
List Office Votes, read your organization’s votes back
List Offices, the offices already covered by Signa

Overview

Trademarks

Parties

Records

Monitoring

Reference

Analytics

Bulk & Sync

Administration

SDK

Retract Office Vote

Overview

Path Parameters

Response

Code Examples

Errors

​Overview

​Path Parameters

​Response

​Code Examples

​Errors

​Related Endpoints

Overview

Path Parameters

Response

Code Examples

Errors

Related Endpoints