Add Entity to List
curl --request PATCH \
--url https://api.replyke.com/api/v6/:projectId/lists/:listId/add-entity \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "<string>"
}
'import requests
url = "https://api.replyke.com/api/v6/:projectId/lists/:listId/add-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/add-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/add-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/add-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/add-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/add-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
Add Entity to List
Add an entity to a list
PATCH
/
:projectId
/
lists
/
:listId
/
add-entity
Add Entity to List
curl --request PATCH \
--url https://api.replyke.com/api/v6/:projectId/lists/:listId/add-entity \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "<string>"
}
'import requests
url = "https://api.replyke.com/api/v6/:projectId/lists/:listId/add-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/add-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/add-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/add-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/add-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/add-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>"
}Adds an entity to the specified list for the authenticated user. Prevents duplicate additions.
Path Parameters
string
required
ID of the target list
Body Parameters
string
required
ID of the entity to add to 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 saved in this list (includes the newly added entity)
string
Creation timestamp in ISO 8601 format
string
Last update timestamp in ISO 8601 format
Error Responses
Missing listId or entityId - 400 Bad Request
Missing listId or entityId - 400 Bad Request
{
"error": "Missing listId",
"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 Already Exists - 409 Conflict
Entity Already Exists - 409 Conflict
{
"error": "Entity already exists in the list",
"code": "list/entity-exists"
}
Server Error - 500 Internal Server Error
Server Error - 500 Internal Server Error
{
"error": "Internal server error.",
"code": "list/server-error",
"details": "<Error message>"
}
Notes
- Entity will not be added again if it already exists in the list.
- The response includes the updated and populated list object.
⌘I