Update a plan file

curl --request PATCH \
  --url https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Plan Terms (v2).pdf",
  "ordering": 1,
  "enabled": true
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/"

payload = {
    "name": "Plan Terms (v2).pdf",
    "ordering": 1,
    "enabled": True
}
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: 'Plan Terms (v2).pdf', ordering: 1, enabled: true})
};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/', 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://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/",
  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' => 'Plan Terms (v2).pdf',
    'ordering' => 1,
    'enabled' => true
  ]),
  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://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/"

	payload := strings.NewReader("{\n  \"name\": \"Plan Terms (v2).pdf\",\n  \"ordering\": 1,\n  \"enabled\": true\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://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Plan Terms (v2).pdf\",\n  \"ordering\": 1,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/")

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\": \"Plan Terms (v2).pdf\",\n  \"ordering\": 1,\n  \"enabled\": true\n}"

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

{
  "id": "bf9f0fe0-c9c0-436d-8811-e412d0365470",
  "name": "custom-pricinig.png",
  "file": "https://cdn.kelviq.com/media/organizations/8/plan/1ad723d2-40eb-4bf0-b924-557e6697e788/53c28d460fed421a81f6c6e90114ff4f/custom-pricinig.png",
  "ordering": 0,
  "enabled": true,
  "downloadUrl": "https://api.kelviq.com/api/v1/catalog/plans/10-july/file/bf9f0fe0-c9c0-436d-8811-e412d0365470/download/"
}

PATCH

catalog

plans

{identifier}

file

{pk}

Update a plan file

curl --request PATCH \
  --url https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Plan Terms (v2).pdf",
  "ordering": 1,
  "enabled": true
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/"

payload = {
    "name": "Plan Terms (v2).pdf",
    "ordering": 1,
    "enabled": True
}
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: 'Plan Terms (v2).pdf', ordering: 1, enabled: true})
};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/', 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://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/",
  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' => 'Plan Terms (v2).pdf',
    'ordering' => 1,
    'enabled' => true
  ]),
  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://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/"

	payload := strings.NewReader("{\n  \"name\": \"Plan Terms (v2).pdf\",\n  \"ordering\": 1,\n  \"enabled\": true\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://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Plan Terms (v2).pdf\",\n  \"ordering\": 1,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/file/{pk}/")

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\": \"Plan Terms (v2).pdf\",\n  \"ordering\": 1,\n  \"enabled\": true\n}"

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

{
  "id": "bf9f0fe0-c9c0-436d-8811-e412d0365470",
  "name": "custom-pricinig.png",
  "file": "https://cdn.kelviq.com/media/organizations/8/plan/1ad723d2-40eb-4bf0-b924-557e6697e788/53c28d460fed421a81f6c6e90114ff4f/custom-pricinig.png",
  "ordering": 0,
  "enabled": true,
  "downloadUrl": "https://api.kelviq.com/api/v1/catalog/plans/10-july/file/bf9f0fe0-c9c0-436d-8811-e412d0365470/download/"
}

Authorizations

Authorization

string

header

required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

identifier

string

required

Plan identifier.

string<uuid>

required

Plan file UUID.

Body

application/json

Update display fields of a plan file. The underlying file cannot be replaced.

name

string

Example:

"Plan Terms (v2).pdf"

ordering

integer

Example:

1

enabled

boolean

Example:

true

Response

Updated plan file.

string<uuid>

read-only

Example:

"bf9f0fe0-c9c0-436d-8811-e412d0365470"

name

string

Example:

"custom-pricinig.png"

file

string<uri>

read-only

Example:

"https://cdn.kelviq.com/media/organizations/8/plan/1ad723d2-40eb-4bf0-b924-557e6697e788/53c28d460fed421a81f6c6e90114ff4f/custom-pricinig.png"

ordering

integer

Example:

0

enabled

boolean

Example:

true

downloadUrl

string<uri>

read-only

URL clients can hit to download the file. Will redirect to a forced-download URL.

Example:

"https://api.kelviq.com/api/v1/catalog/plans/10-july/file/bf9f0fe0-c9c0-436d-8811-e412d0365470/download/"

Get Started

API Documentation

Update a plan file

Authorizations

Path Parameters

Body

Response