Update an API key

Rename an API key or pin it to a dated API version. At least one of name or version is required.

PATCH /v1/api_keys/{id}

Update an API key

cURL

curl --request PATCH \
  --url https://api.newinvoice.dev/v1/api_keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "renamed key"
}
'

import requests

url = "https://api.newinvoice.dev/v1/api_keys/{id}"

payload = { "name": "renamed key" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'renamed key'})
};

fetch('https://api.newinvoice.dev/v1/api_keys/{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.newinvoice.dev/v1/api_keys/{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' => 'renamed key'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.newinvoice.dev/v1/api_keys/{id}"

	payload := strings.NewReader("{\n  \"name\": \"renamed key\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.newinvoice.dev/v1/api_keys/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"renamed key\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.newinvoice.dev/v1/api_keys/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"renamed key\"\n}"

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

200

{
  "object": "api_key",
  "id": "obj_2P9K3sample",
  "name": "string",
  "mode": "test",
  "prefix": "sk_live_ab12",
  "last_used_at": "2026-07-10T18:25:43Z",
  "revoked_at": "2026-07-10T18:25:43Z",
  "version": "string",
  "created_at": "2026-07-10T18:25:43Z"
}

{
  "type": "https://errors.invoiceapi.mx/auth_unauthorized",
  "title": "Authentication required",
  "status": 401,
  "code": "auth.unauthorized",
  "detail": "Missing or invalid API key.",
  "remediation": "Send `Authorization: Bearer sk_test_...` (or sk_live_...) with a valid API key.",
  "doc_url": "/docs/errors#auth-unauthorized",
  "request_id": "req_2P9K3sample"
}

{
  "type": "https://errors.invoiceapi.mx/resource_not_found",
  "title": "Resource not found",
  "status": 404,
  "code": "resource.not_found",
  "detail": "No such id in this org + mode.",
  "remediation": "Verify the id and that the key mode (test/live) matches the id.",
  "doc_url": "/docs/errors#resource-not_found",
  "request_id": "req_2P9K3sample"
}

{
  "type": "https://errors.invoiceapi.mx/request_validation_failed",
  "title": "Request validation failed",
  "status": 422,
  "code": "request.validation_failed",
  "detail": "One or more fields did not satisfy the schema.",
  "remediation": "Fix the fields listed in `errors` and resubmit.",
  "doc_url": "/docs/errors#request-validation_failed",
  "request_id": "req_2P9K3sample"
}

{
  "type": "https://errors.invoiceapi.mx/rate_limit_exceeded",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limit.exceeded",
  "detail": "Too many requests for this key + request class (reads and writes are limited separately).",
  "remediation": "Back off and retry after the number of seconds in the Retry-After header; batch work or lower your request rate.",
  "doc_url": "/docs/errors#rate_limit-exceeded",
  "request_id": "req_2P9K3sample"
}

{
  "type": "https://errors.invoiceapi.mx/internal_error",
  "title": "Internal server error",
  "status": 500,
  "code": "internal.error",
  "detail": "An unexpected error occurred.",
  "remediation": "Retry later; contact support with the request_id if it persists.",
  "doc_url": "/docs/errors#internal-error",
  "request_id": "req_2P9K3sample"
}

Authorizations

Authorization · string · header · required

API key: Authorization: Bearer sk_test_... or sk_live_....

Headers

Invoice-Version · string

Pin a dated API release (Stripe-style). Omit to use the current version. An unknown value returns 400 request.invalid_version. Echoed back on every response.

Example:

"2026-07-10"

Invoice-Account · string

Connect: act on behalf of one of your connected accounts (its acct_…/org_… id). Omit to act as your own organization. Not honored on /v1/api_keys.

Example:

"org_2P9connectedacct"

Path Parameters

id · string · required

API-key id, e.g. "ak_2P9K3sample".

Body

application/json

name · string

New human label for the key.

Required string length: 1 - 100

version · string

Pin the key to a supported dated API version, e.g. "2026-07-10"; validated against the version registry.

Minimum string length: 1

Response

200

application/json

Default Response

object · enum<string> · required

Always "api_key".

Available options: api_key

id · string · required

API-key id, e.g. "ak_2P9K3sample".

name · string | null · required

Human label, or null if unset.

mode · enum<string> · required

Environment this key stamps against: "test" or "live".

Available options: test, live

prefix · string · required

Non-secret key prefix used to identify the key, e.g. "sk_live_ab12".

last_used_at · string | null · required

When the key was last used (ISO-8601 UTC), or null.

revoked_at · string | null · required

When the key was revoked (ISO-8601 UTC), or null if active.

version · string | null · required

Pinned dated API version, or null to follow the current version.

created_at · string · required

Creation timestamp, ISO-8601 UTC.