Toggle Favorite

curl --request POST \
  --url https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite

import requests

url = "https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite', 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.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite"

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

	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.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite")

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

request = Net::HTTP::Post.new(url)

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

POST

app

organizations

{organizationId}

projects

{projectId}

saved-searches

{id}

favorite

Toggle Favorite

curl --request POST \
  --url https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite

import requests

url = "https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite', 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.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite"

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

	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.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/app/v1/organizations/{organizationId}/projects/{projectId}/saved-searches/{id}/favorite")

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

request = Net::HTTP::Post.new(url)

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

Toggles the favorite status of a saved search for the current user. If the search is already favorited, it will be unfavorited, and vice versa.

Path Parameters

organizationId

string

required

Organization ID

projectId

string

required

Project ID

string

required

Saved search ID

Response

{
  "data": {
    "id": "ss123",
    "favorited": true
  }
}

When unfavoriting:

{
  "data": {
    "id": "ss123",
    "favorited": false
  }
}

Error Responses

Saved Search Not Found

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Saved search not found"
  }
}

Code Examples

curl -X POST "https://api.metabind.ai/app/v1/organizations/org123/projects/proj456/saved-searches/ss123/favorite" \
  -H "Authorization: Bearer YOUR_JWT"

const response = await fetch(
  'https://api.metabind.ai/app/v1/organizations/org123/projects/proj456/saved-searches/ss123/favorite',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_JWT'
    }
  }
);

const { data } = await response.json();
console.log(`Saved search ${data.id} is ${data.favorited ? 'now' : 'no longer'} a favorite`);

var request = URLRequest(url: URL(string: "https://api.metabind.ai/app/v1/organizations/org123/projects/proj456/saved-searches/ss123/favorite")!)
request.httpMethod = "POST"
request.setValue("Bearer YOUR_JWT", forHTTPHeaderField: "Authorization")

let (data, _) = try await URLSession.shared.data(for: request)
let result = try JSONDecoder().decode(FavoriteResponse.self, from: data)
print("Favorited: \(result.favorited)")

val response = client.post("https://api.metabind.ai/app/v1/organizations/org123/projects/proj456/saved-searches/ss123/favorite") {
    header("Authorization", "Bearer YOUR_JWT")
}

val result = response.body<FavoriteResponse>()
println("Favorited: ${result.favorited}")

Execute Saved Search Folders Overview

​Path Parameters

​Response

​Error Responses

​Saved Search Not Found

​Code Examples

Path Parameters

Response

Error Responses

Saved Search Not Found

Code Examples