Skip to main content
POST
/
pipelines
/
batch
batch create pipeline
curl --request POST \
  --url https://api.klipy.ai/api/v2/pipelines/batch \
  --header 'Content-Type: application/json' \
  --header 'X-Klipy-Api-Key: <api-key>' \
  --data '
[
  {
    "description": "<string>",
    "is_default": true,
    "is_public": true,
    "name": "<string>",
    "stages": [
      {
        "color": "<string>",
        "id": "<string>",
        "index": 123,
        "name": "<string>",
        "variant": "<string>",
        "description": "<string>"
      }
    ]
  }
]
'
import requests

url = "https://api.klipy.ai/api/v2/pipelines/batch"

payload = [
{
"description": "<string>",
"is_default": True,
"is_public": True,
"name": "<string>",
"stages": [
{
"color": "<string>",
"id": "<string>",
"index": 123,
"name": "<string>",
"variant": "<string>",
"description": "<string>"
}
]
}
]
headers = {
"X-Klipy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-Klipy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
description: '<string>',
is_default: true,
is_public: true,
name: '<string>',
stages: [
{
color: '<string>',
id: '<string>',
index: 123,
name: '<string>',
variant: '<string>',
description: '<string>'
}
]
}
])
};

fetch('https://api.klipy.ai/api/v2/pipelines/batch', 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.klipy.ai/api/v2/pipelines/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'description' => '<string>',
'is_default' => true,
'is_public' => true,
'name' => '<string>',
'stages' => [
[
'color' => '<string>',
'id' => '<string>',
'index' => 123,
'name' => '<string>',
'variant' => '<string>',
'description' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Klipy-Api-Key: <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://api.klipy.ai/api/v2/pipelines/batch"

payload := strings.NewReader("[\n {\n \"description\": \"<string>\",\n \"is_default\": true,\n \"is_public\": true,\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"name\": \"<string>\",\n \"variant\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n]")

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

req.Header.Add("X-Klipy-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))

}
HttpResponse<String> response = Unirest.post("https://api.klipy.ai/api/v2/pipelines/batch")
.header("X-Klipy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"description\": \"<string>\",\n \"is_default\": true,\n \"is_public\": true,\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"name\": \"<string>\",\n \"variant\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n]")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.klipy.ai/api/v2/pipelines/batch")

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

request = Net::HTTP::Post.new(url)
request["X-Klipy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"description\": \"<string>\",\n \"is_default\": true,\n \"is_public\": true,\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"name\": \"<string>\",\n \"variant\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n]"

response = http.request(request)
puts response.read_body
{
  "data": {
    "items": [
      {
        "data": {},
        "error": {
          "code": "<string>",
          "details": [
            {}
          ],
          "message": "<string>"
        },
        "index": 123
      }
    ],
    "summary": {
      "failed": 123,
      "succeeded": 123,
      "total": 123
    }
  },
  "meta": {
    "api_version": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}

Authorizations

X-Klipy-Api-Key
string
header
required

Body

application/json
Required array length: 1 - 100 elements
closed_lost_stage
object
closed_won_stage
object
default_ui
enum<string>
Available options:
kanban,
list
description
string
is_default
boolean
is_public
boolean
name
string
stages
object[]

Response

A batch-create multi-status result. Always 200; per-item outcomes and a summary live in the body.

data
object
meta
object
object
string
Last modified on July 11, 2026