Skip to main content
PUT
/
account
/
api
/
{key}
Update API key
import requests

url = "https://api.pdfshift.io/v3/account/api/{key}"

payload = { "name": "<string>" }
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>'})
};

fetch('https://api.pdfshift.io/v3/account/api/{key}', 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.pdfshift.io/v3/account/api/{key}",
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>'
]),
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;
}
require 'uri'
require 'net/http'

url = URI("https://api.pdfshift.io/v3/account/api/{key}")

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}"

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

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

func main() {

url := "https://api.pdfshift.io/v3/account/api/{key}"

payload := strings.NewReader("{\n \"name\": \"<string>\"\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))

}
using RestSharp;


var options = new RestClientOptions("https://api.pdfshift.io/v3/account/api/{key}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
request.AddJsonBody("{\n \"name\": \"<string>\"\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.put("https://api.pdfshift.io/v3/account/api/{key}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();
curl --request PUT \
--url https://api.pdfshift.io/v3/account/api/{key} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>"
}
'
{
  "success": true,
  "key": {
    "created": 1734076868000,
    "name": "Renamed key",
    "removed": null,
    "token": "sk_3a1f9c2b4d5e6f708192a3b4c5d6e7f8",
    "public": "9f8e7d6c5b4a3928176054f3e2d1c0b9",
    "last_used": 1764753251000,
    "usage": 42,
    "is_master": true
  }
}
{
"success": true,
"error": "<string>",
"code": 123
}
{
"success": true,
"error": "<string>",
"code": 123
}
{
"success": true,
"error": "<string>",
"code": 123
}
{
"success": true,
"error": "<string>",
"code": 123
}
{
"success": true,
"error": "<string>",
"code": 123
}

Authorizations

X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Path Parameters

key
string
required

The secret key (token) of the API key to update.

Body

application/json
name
string

A human-friendly name to identify the API key.

Maximum string length: 250

Response

API key updated

success
boolean
key
object