Remove Entity from List
curl --request PATCH \
--url https://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "<string>"
}
'import requests
url = "https://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity"
payload = { "entityId": "<string>" }
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({entityId: '<string>'})
};
fetch('https://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity', 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.replyke.com/api/v6/:projectId/lists/:listId/remove-entity",
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([
'entityId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity"
payload := strings.NewReader("{\n \"entityId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"projectId": "<string>",
"userId": "<string>",
"name": "<string>",
"entityIds": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}List Endpoints
Remove Entity from List
Remove an entity from a list
PATCH
/
:projectId
/
lists
/
:listId
/
remove-entity
Remove Entity from List
curl --request PATCH \
--url https://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "<string>"
}
'import requests
url = "https://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity"
payload = { "entityId": "<string>" }
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({entityId: '<string>'})
};
fetch('https://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity', 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.replyke.com/api/v6/:projectId/lists/:listId/remove-entity",
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([
'entityId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity"
payload := strings.NewReader("{\n \"entityId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.replyke.com/api/v6/:projectId/lists/:listId/remove-entity")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"projectId": "<string>",
"userId": "<string>",
"name": "<string>",
"entityIds": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}Removes an entity from the specified list for the authenticated user.
Path Parameters
string
required
ID of the target list
Body Parameters
string
required
ID of the entity to remove from the list
Response
string
Unique list identifier
string
Project identifier
string
ID of the user who owns the list
string
Name of the list
array
Updated array of entity IDs (with the removed entity excluded)
string
Creation timestamp in ISO 8601 format
string
Last update timestamp in ISO 8601 format
Error Responses
Missing Parameters - 400 Bad Request
Missing Parameters - 400 Bad Request
{
"error": "Missing listId or entityId",
"code": "list/missing-data"
}
List Not Found - 404 Not Found
List Not Found - 404 Not Found
{
"error": "List not found",
"code": "list/not-found"
}
Entity Not Found in List - 409 Conflict
Entity Not Found in List - 409 Conflict
{
"error": "Entity does not exist in the list",
"code": "list/entity-not-found"
}
Server Error - 500 Internal Server Error
Server Error - 500 Internal Server Error
{
"error": "Internal server error.",
"code": "list/server-error",
"details": "<Error message>"
}
Notes
- This operation has no effect if the entity is not already in the list.
- The response includes the updated list with the entity removed.
⌘I