Skip to main content
Support

Update a clip

PATCH https://api.helpdocs.io/v1/clip/{clip_id}

Example request

Generated
Parameters
curl -X PATCH https://api.helpdocs.io/v1/clip/ahovCJQX4b \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "content": "string",
    "is_private": true,
    "is_locked": true,
    "is_template": true
  }'
curl -X PATCH https://api.helpdocs.io/v1/clip/ahovCJQX4b \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'
const url = "https://api.helpdocs.io/v1/clip/ahovCJQX4b";

const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "title": "string",
    "content": "string",
    "is_private": true,
    "is_locked": true,
    "is_template": true
  }),
});

const data = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/clip/ahovCJQX4b";

const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
});

const data = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/clip/ahovCJQX4b";

const options: RequestInit = {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "title": "string",
    "content": "string",
    "is_private": true,
    "is_locked": true,
    "is_template": true
  }),
};

const response = await fetch(url, options);

const data: unknown = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/clip/ahovCJQX4b";

const options: RequestInit = {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
};

const response = await fetch(url, options);

const data: unknown = await response.json();
console.log(data);
import requests

url = "https://api.helpdocs.io/v1/clip/ahovCJQX4b"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}

payload = {
    "title": "string",
    "content": "string",
    "is_private": True,
    "is_locked": True,
    "is_template": True,
}

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

print(response.json())
import requests

url = "https://api.helpdocs.io/v1/clip/ahovCJQX4b"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}

payload = {}

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

print(response.json())
<?php

$ch = curl_init("https://api.helpdocs.io/v1/clip/ahovCJQX4b");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PATCH",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_TOKEN",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "title" => "string",
        "content" => "string",
        "is_private" => true,
        "is_locked" => true,
        "is_template" => true,
    ]),
]);

$response = curl_exec($ch);

print_r(json_decode($response, true));
<?php

$ch = curl_init("https://api.helpdocs.io/v1/clip/ahovCJQX4b");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PATCH",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_TOKEN",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);

$response = curl_exec($ch);

print_r(json_decode($response, true));
package main

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

func main() {
	body := strings.NewReader(`{
  "title": "string",
  "content": "string",
  "is_private": true,
  "is_locked": true,
  "is_template": true
}`)

	req, err := http.NewRequest(http.MethodPatch, "https://api.helpdocs.io/v1/clip/ahovCJQX4b", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}
package main

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

func main() {
	body := strings.NewReader("{}")

	req, err := http.NewRequest(http.MethodPatch, "https://api.helpdocs.io/v1/clip/ahovCJQX4b", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.helpdocs.io/v1/clip/ahovCJQX4b"))
            .header("Authorization", "Bearer YOUR_TOKEN")
            .header("Content-Type", "application/json")
            .method("PATCH", HttpRequest.BodyPublishers.ofString("""
                {
                  "title": "string",
                  "content": "string",
                  "is_private": true,
                  "is_locked": true,
                  "is_template": true
                }"""))
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.helpdocs.io/v1/clip/ahovCJQX4b"))
            .header("Authorization", "Bearer YOUR_TOKEN")
            .header("Content-Type", "application/json")
            .method("PATCH", HttpRequest.BodyPublishers.ofString("""
                {}"""))
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
require "json"
require "net/http"

uri = URI("https://api.helpdocs.io/v1/clip/ahovCJQX4b")

request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "title" => "string",
  "content" => "string",
  "is_private" => true,
  "is_locked" => true,
  "is_template" => true,
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

pp JSON.parse(response.body)
require "json"
require "net/http"

uri = URI("https://api.helpdocs.io/v1/clip/ahovCJQX4b")

request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Content-Type"] = "application/json"
request.body = JSON.generate({})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

pp JSON.parse(response.body)
using System.Text;

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.helpdocs.io/v1/clip/ahovCJQX4b");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");
request.Content = new StringContent(
    """
    {
      "title": "string",
      "content": "string",
      "is_private": true,
      "is_locked": true,
      "is_template": true
    }
    """,
    Encoding.UTF8,
    "application/json");

var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());
using System.Text;

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.helpdocs.io/v1/clip/ahovCJQX4b");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");
request.Content = new StringContent(
    """
    {}
    """,
    Encoding.UTF8,
    "application/json");

var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

Responses

{
  "clip": {
    "clip_id": "string",
    "title": "string",
    "content": "string",
    "user_id": "string",
    "is_private": true,
    "is_locked": true,
    "is_template": true,
    "created_at": "2024-01-15T09:30:00Z"
  }
}

The updated clip.

Schemas
string

The request was rejected: a required field is missing from the body, or a value in it is not acceptable.

Schemas
{
  "code": 1,
  "err": "string"
}

Authentication failed or no API key was supplied.

Schemas
{
  "code": 1,
  "err": "string"
}

The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.

Schemas
{
  "code": 1,
  "err": "string"
}

The key lacks write permission, or the account’s plan does not include API access.

Schemas
string

No such resource in this account, or clip_id does not match the pattern this route accepts.

Schemas
string

The clip is used as a dynamic clip by an article, so it cannot be made private.

Schemas
{
  "code": 1,
  "err": "string"
}

Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.

Schemas
Generated

Updates the supplied fields and leaves the rest untouched. Every article embedding the clip picks up the change the next time it is rendered.

Authentication

    • ApiKeyBearer http bearer

      An API key sent as Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.

    • OAuth2 oauth2

      An OAuth 2.0 access token for an app acting on behalf of a HelpDocs user, sent as Authorization: Bearer <token>. The authorization code flow requires PKCE (S256). Each operation names the one scope it needs.

      Scopes write:articles

Path parameters

  • clip_id string Required

    pattern ^[a-zA-Z0-9]{10}$

Request body Required

The fields to change.

application/json UpdateClipRequest
  • title string Nullable

    Null is the same as leaving the field out.

  • content string Nullable

    Null is the same as leaving the field out.

  • is_private boolean Nullable

    Null is the same as leaving the field out.

  • is_locked boolean Nullable

    Null is the same as leaving the field out.

  • is_template boolean Nullable

    Null is the same as leaving the field out.

{
  "title": "string",
  "content": "string",
  "is_private": true,
  "is_locked": true,
  "is_template": true
}

Generated from the schema

Responses

200

The updated clip.

application/json ClipResponse
  • clip Clip Required Nullable
400

The request was rejected: a required field is missing from the body, or a value in it is not acceptable.

text/plain

The failure, as a human-readable message.

  • string

    The failure, as a human-readable message.

401

Authentication failed or no API key was supplied.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

402

The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

403

The key lacks write permission, or the account’s plan does not include API access.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

404

No such resource in this account, or clip_id does not match the pattern this route accepts.

text/plain

The failure, as a human-readable message.

  • string

    The failure, as a human-readable message.

409

The clip is used as a dynamic clip by an article, so it cannot be made private.

text/plain

The failure, as a human-readable message.

  • string

    The failure, as a human-readable message.

429

Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.

headers

  • Retry-After integer
  • X-RateLimit-Limit integer
  • X-RateLimit-Remaining integer
  • X-RateLimit-Reset integer
application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

All endpoints