Update a pipeline version - Clerk Chat

Update a pipeline version

curl --request PATCH \
  --url https://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId} \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "name": "Renamed Version"
}
'

import requests

url = "https://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}"

payload = { "name": "Renamed Version" }
headers = {
    "apiKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Renamed Version'})
};

fetch('https://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}', 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://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}",
  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 Version'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apiKey: <api-key>"
  ],
]);

$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://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}"

	payload := strings.NewReader("{\n  \"name\": \"Renamed Version\"\n}")

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

	req.Header.Add("apiKey", "<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://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}")
  .header("apiKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Renamed Version\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}")

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

request = Net::HTTP::Patch.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Renamed Version\"\n}"

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

{
  "id": "00000000-0000-0000-0000-000000000000",
  "number": 1,
  "pipelineId": "00000000-0000-0000-0000-000000000000",
  "schema": {},
  "isLatestLive": true,
  "name": "My Version",
  "pipelineOptions": {},
  "versionId": "00000000-0000-0000-0000-000000000000",
  "versionNumber": 1,
  "versionName": "My Version",
  "madeLiveAt": "2021-01-01T00:00:00.000Z"
}

PATCH

/

public

/

pipelines

/

{pipelineId}

/

versions

/

{versionId}

Update a pipeline version

curl --request PATCH \
  --url https://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId} \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "name": "Renamed Version"
}
'

import requests

url = "https://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}"

payload = { "name": "Renamed Version" }
headers = {
    "apiKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Renamed Version'})
};

fetch('https://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}', 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://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}",
  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 Version'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apiKey: <api-key>"
  ],
]);

$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://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}"

	payload := strings.NewReader("{\n  \"name\": \"Renamed Version\"\n}")

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

	req.Header.Add("apiKey", "<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://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}")
  .header("apiKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Renamed Version\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://web-api.clerk.chat/public/pipelines/{pipelineId}/versions/{versionId}")

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

request = Net::HTTP::Patch.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Renamed Version\"\n}"

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

{
  "id": "00000000-0000-0000-0000-000000000000",
  "number": 1,
  "pipelineId": "00000000-0000-0000-0000-000000000000",
  "schema": {},
  "isLatestLive": true,
  "name": "My Version",
  "pipelineOptions": {},
  "versionId": "00000000-0000-0000-0000-000000000000",
  "versionNumber": 1,
  "versionName": "My Version",
  "madeLiveAt": "2021-01-01T00:00:00.000Z"
}

Authorizations

apiKey

string

header

required

Path Parameters

pipelineId

string<uuid>

required

The ID of the pipeline

versionId

string<uuid>

required

The ID of the pipeline version

Body

application/json

name

string

The new name for the pipeline version

Example:

"Renamed Version"

Response

The updated pipeline version

Represents a pipeline version resource

id

string<uuid>

required

The ID of the pipeline version

Example:

"00000000-0000-0000-0000-000000000000"

number

number

required

The version number

Example:

1

pipelineId

string<uuid>

required

The ID of the parent pipeline

Example:

"00000000-0000-0000-0000-000000000000"

schema

object

required

The pipeline schema definition

isLatestLive

boolean

required

Whether this is the latest live version

Example:

true

name

string | null

The name of the pipeline version

Example:

"My Version"

pipelineOptions

object

Pipeline configuration options

versionId

string<uuid>

The ID of the pipeline version (alias for id)

Example:

"00000000-0000-0000-0000-000000000000"

versionNumber

number

The version number (alias for number)

Example:

1

versionName

string | null

The name of the pipeline version (alias for name)

Example:

"My Version"

madeLiveAt

string<date-time> | null

When this version was made live

Example:

"2021-01-01T00:00:00.000Z"