Update a keyword
curl --request PATCH \
--url https://api.nephia.cc/v1/keywords/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"refreshIntervalSeconds": 123,
"webhookUrl": "",
"aiEnabled": true,
"aiPrompt": "<string>",
"aiStep": {
"instruction": "<string>",
"schema": {}
},
"sentimentEnabled": true,
"coBrandsEnabled": true,
"muteRules": [
"<string>"
],
"vipAuthors": [
"<string>"
],
"rules": [
{
"name": "<string>",
"when": {
"kind": "item",
"all": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"then": [
{
"channelIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true
}
],
"webhookEvents": [],
"channels": [
{
"channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"sources": [
{
"enabled": true,
"searches": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"overridesEnabled": true,
"overrides": {
"market": "<string>",
"query": "<string>",
"priceMin": 123,
"priceMax": 123,
"sort": "<string>",
"page": 123,
"perPage": 123,
"filters": {},
"terms": [
"<string>"
],
"repliesTo": "<string>"
}
}
],
"refreshIntervalSeconds": 123
}
],
"schedule": {
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"timezone": "<string>"
}
}
'import requests
url = "https://api.nephia.cc/v1/keywords/{id}"
payload = {
"name": "<string>",
"refreshIntervalSeconds": 123,
"webhookUrl": "",
"aiEnabled": True,
"aiPrompt": "<string>",
"aiStep": {
"instruction": "<string>",
"schema": {}
},
"sentimentEnabled": True,
"coBrandsEnabled": True,
"muteRules": ["<string>"],
"vipAuthors": ["<string>"],
"rules": [
{
"name": "<string>",
"when": {
"kind": "item",
"all": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"then": [{ "channelIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": True
}
],
"webhookEvents": [],
"channels": [{ "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
"sources": [
{
"enabled": True,
"searches": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"overridesEnabled": True,
"overrides": {
"market": "<string>",
"query": "<string>",
"priceMin": 123,
"priceMax": 123,
"sort": "<string>",
"page": 123,
"perPage": 123,
"filters": {},
"terms": ["<string>"],
"repliesTo": "<string>"
}
}
],
"refreshIntervalSeconds": 123
}
],
"schedule": {
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"timezone": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
refreshIntervalSeconds: 123,
webhookUrl: '',
aiEnabled: true,
aiPrompt: '<string>',
aiStep: {instruction: '<string>', schema: {}},
sentimentEnabled: true,
coBrandsEnabled: true,
muteRules: ['<string>'],
vipAuthors: ['<string>'],
rules: [
{
name: '<string>',
when: {kind: 'item', all: [{field: '<string>', value: '<string>'}]},
then: [{channelIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']}],
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
enabled: true
}
],
webhookEvents: [],
channels: [{channelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
sources: [
{
enabled: true,
searches: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
label: '<string>',
overridesEnabled: true,
overrides: {
market: '<string>',
query: '<string>',
priceMin: 123,
priceMax: 123,
sort: '<string>',
page: 123,
perPage: 123,
filters: {},
terms: ['<string>'],
repliesTo: '<string>'
}
}
],
refreshIntervalSeconds: 123
}
],
schedule: {
startsAt: '2023-11-07T05:31:56Z',
endsAt: '2023-11-07T05:31:56Z',
timezone: '<string>'
}
})
};
fetch('https://api.nephia.cc/v1/keywords/{id}', 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.nephia.cc/v1/keywords/{id}",
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' => '<string>',
'refreshIntervalSeconds' => 123,
'webhookUrl' => '',
'aiEnabled' => true,
'aiPrompt' => '<string>',
'aiStep' => [
'instruction' => '<string>',
'schema' => [
]
],
'sentimentEnabled' => true,
'coBrandsEnabled' => true,
'muteRules' => [
'<string>'
],
'vipAuthors' => [
'<string>'
],
'rules' => [
[
'name' => '<string>',
'when' => [
'kind' => 'item',
'all' => [
[
'field' => '<string>',
'value' => '<string>'
]
]
],
'then' => [
[
'channelIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'enabled' => true
]
],
'webhookEvents' => [
],
'channels' => [
[
'channelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'sources' => [
[
'enabled' => true,
'searches' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'label' => '<string>',
'overridesEnabled' => true,
'overrides' => [
'market' => '<string>',
'query' => '<string>',
'priceMin' => 123,
'priceMax' => 123,
'sort' => '<string>',
'page' => 123,
'perPage' => 123,
'filters' => [
],
'terms' => [
'<string>'
],
'repliesTo' => '<string>'
]
]
],
'refreshIntervalSeconds' => 123
]
],
'schedule' => [
'startsAt' => '2023-11-07T05:31:56Z',
'endsAt' => '2023-11-07T05:31:56Z',
'timezone' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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.nephia.cc/v1/keywords/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"refreshIntervalSeconds\": 123,\n \"webhookUrl\": \"\",\n \"aiEnabled\": true,\n \"aiPrompt\": \"<string>\",\n \"aiStep\": {\n \"instruction\": \"<string>\",\n \"schema\": {}\n },\n \"sentimentEnabled\": true,\n \"coBrandsEnabled\": true,\n \"muteRules\": [\n \"<string>\"\n ],\n \"vipAuthors\": [\n \"<string>\"\n ],\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"kind\": \"item\",\n \"all\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"then\": [\n {\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n }\n ],\n \"webhookEvents\": [],\n \"channels\": [\n {\n \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sources\": [\n {\n \"enabled\": true,\n \"searches\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"overridesEnabled\": true,\n \"overrides\": {\n \"market\": \"<string>\",\n \"query\": \"<string>\",\n \"priceMin\": 123,\n \"priceMax\": 123,\n \"sort\": \"<string>\",\n \"page\": 123,\n \"perPage\": 123,\n \"filters\": {},\n \"terms\": [\n \"<string>\"\n ],\n \"repliesTo\": \"<string>\"\n }\n }\n ],\n \"refreshIntervalSeconds\": 123\n }\n ],\n \"schedule\": {\n \"startsAt\": \"2023-11-07T05:31:56Z\",\n \"endsAt\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-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.patch("https://api.nephia.cc/v1/keywords/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"refreshIntervalSeconds\": 123,\n \"webhookUrl\": \"\",\n \"aiEnabled\": true,\n \"aiPrompt\": \"<string>\",\n \"aiStep\": {\n \"instruction\": \"<string>\",\n \"schema\": {}\n },\n \"sentimentEnabled\": true,\n \"coBrandsEnabled\": true,\n \"muteRules\": [\n \"<string>\"\n ],\n \"vipAuthors\": [\n \"<string>\"\n ],\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"kind\": \"item\",\n \"all\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"then\": [\n {\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n }\n ],\n \"webhookEvents\": [],\n \"channels\": [\n {\n \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sources\": [\n {\n \"enabled\": true,\n \"searches\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"overridesEnabled\": true,\n \"overrides\": {\n \"market\": \"<string>\",\n \"query\": \"<string>\",\n \"priceMin\": 123,\n \"priceMax\": 123,\n \"sort\": \"<string>\",\n \"page\": 123,\n \"perPage\": 123,\n \"filters\": {},\n \"terms\": [\n \"<string>\"\n ],\n \"repliesTo\": \"<string>\"\n }\n }\n ],\n \"refreshIntervalSeconds\": 123\n }\n ],\n \"schedule\": {\n \"startsAt\": \"2023-11-07T05:31:56Z\",\n \"endsAt\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nephia.cc/v1/keywords/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"refreshIntervalSeconds\": 123,\n \"webhookUrl\": \"\",\n \"aiEnabled\": true,\n \"aiPrompt\": \"<string>\",\n \"aiStep\": {\n \"instruction\": \"<string>\",\n \"schema\": {}\n },\n \"sentimentEnabled\": true,\n \"coBrandsEnabled\": true,\n \"muteRules\": [\n \"<string>\"\n ],\n \"vipAuthors\": [\n \"<string>\"\n ],\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"kind\": \"item\",\n \"all\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"then\": [\n {\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n }\n ],\n \"webhookEvents\": [],\n \"channels\": [\n {\n \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sources\": [\n {\n \"enabled\": true,\n \"searches\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"overridesEnabled\": true,\n \"overrides\": {\n \"market\": \"<string>\",\n \"query\": \"<string>\",\n \"priceMin\": 123,\n \"priceMax\": 123,\n \"sort\": \"<string>\",\n \"page\": 123,\n \"perPage\": 123,\n \"filters\": {},\n \"terms\": [\n \"<string>\"\n ],\n \"repliesTo\": \"<string>\"\n }\n }\n ],\n \"refreshIntervalSeconds\": 123\n }\n ],\n \"schedule\": {\n \"startsAt\": \"2023-11-07T05:31:56Z\",\n \"endsAt\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"keyword": {
"id": "<string>",
"name": "<string>",
"kind": "catalog",
"globalCriteria": {},
"refreshIntervalSeconds": 123,
"sources": [
{
"source": "x",
"enabled": true,
"searches": [
{
"id": "<string>",
"label": "<string>",
"overridesEnabled": true,
"overrides": {},
"resolvedCriteria": {}
}
],
"refreshIntervalSeconds": 123
}
],
"webhookUrl": "<string>",
"webhookMode": "all",
"webhookEvents": [
"keyword.alert_fired"
],
"aiEnabled": true,
"aiPreset": "<string>",
"aiPrompt": "<string>",
"aiStep": {},
"sentimentEnabled": true,
"coBrandsEnabled": true,
"subjectRole": "own",
"muteRules": [
"<unknown>"
],
"vipAuthors": [
"<unknown>"
],
"rules": [
"<unknown>"
],
"schedule": {},
"isActive": true,
"pausedReason": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"resetSearches": [
{
"source": "x",
"searchId": "<string>",
"label": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "Rate limit exceeded",
"code": "TOO_MANY_REQUESTS"
}Keywords
Update a keyword
A real patch: a key you do not send is left alone, and a key sent as null clears it. The difference matters: a search whose terms, filters or market change is started over, and its first check records what currently matches without emitting it. The mentions it caught before stay on the keyword. A new interval or webhook applies to the running searches and starts nothing over. resetSearches in the response names the searches that were started over.
PATCH
/
v1
/
keywords
/
{id}
Update a keyword
curl --request PATCH \
--url https://api.nephia.cc/v1/keywords/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"refreshIntervalSeconds": 123,
"webhookUrl": "",
"aiEnabled": true,
"aiPrompt": "<string>",
"aiStep": {
"instruction": "<string>",
"schema": {}
},
"sentimentEnabled": true,
"coBrandsEnabled": true,
"muteRules": [
"<string>"
],
"vipAuthors": [
"<string>"
],
"rules": [
{
"name": "<string>",
"when": {
"kind": "item",
"all": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"then": [
{
"channelIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true
}
],
"webhookEvents": [],
"channels": [
{
"channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"sources": [
{
"enabled": true,
"searches": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"overridesEnabled": true,
"overrides": {
"market": "<string>",
"query": "<string>",
"priceMin": 123,
"priceMax": 123,
"sort": "<string>",
"page": 123,
"perPage": 123,
"filters": {},
"terms": [
"<string>"
],
"repliesTo": "<string>"
}
}
],
"refreshIntervalSeconds": 123
}
],
"schedule": {
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"timezone": "<string>"
}
}
'import requests
url = "https://api.nephia.cc/v1/keywords/{id}"
payload = {
"name": "<string>",
"refreshIntervalSeconds": 123,
"webhookUrl": "",
"aiEnabled": True,
"aiPrompt": "<string>",
"aiStep": {
"instruction": "<string>",
"schema": {}
},
"sentimentEnabled": True,
"coBrandsEnabled": True,
"muteRules": ["<string>"],
"vipAuthors": ["<string>"],
"rules": [
{
"name": "<string>",
"when": {
"kind": "item",
"all": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"then": [{ "channelIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": True
}
],
"webhookEvents": [],
"channels": [{ "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
"sources": [
{
"enabled": True,
"searches": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"overridesEnabled": True,
"overrides": {
"market": "<string>",
"query": "<string>",
"priceMin": 123,
"priceMax": 123,
"sort": "<string>",
"page": 123,
"perPage": 123,
"filters": {},
"terms": ["<string>"],
"repliesTo": "<string>"
}
}
],
"refreshIntervalSeconds": 123
}
],
"schedule": {
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"timezone": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
refreshIntervalSeconds: 123,
webhookUrl: '',
aiEnabled: true,
aiPrompt: '<string>',
aiStep: {instruction: '<string>', schema: {}},
sentimentEnabled: true,
coBrandsEnabled: true,
muteRules: ['<string>'],
vipAuthors: ['<string>'],
rules: [
{
name: '<string>',
when: {kind: 'item', all: [{field: '<string>', value: '<string>'}]},
then: [{channelIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']}],
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
enabled: true
}
],
webhookEvents: [],
channels: [{channelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
sources: [
{
enabled: true,
searches: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
label: '<string>',
overridesEnabled: true,
overrides: {
market: '<string>',
query: '<string>',
priceMin: 123,
priceMax: 123,
sort: '<string>',
page: 123,
perPage: 123,
filters: {},
terms: ['<string>'],
repliesTo: '<string>'
}
}
],
refreshIntervalSeconds: 123
}
],
schedule: {
startsAt: '2023-11-07T05:31:56Z',
endsAt: '2023-11-07T05:31:56Z',
timezone: '<string>'
}
})
};
fetch('https://api.nephia.cc/v1/keywords/{id}', 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.nephia.cc/v1/keywords/{id}",
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' => '<string>',
'refreshIntervalSeconds' => 123,
'webhookUrl' => '',
'aiEnabled' => true,
'aiPrompt' => '<string>',
'aiStep' => [
'instruction' => '<string>',
'schema' => [
]
],
'sentimentEnabled' => true,
'coBrandsEnabled' => true,
'muteRules' => [
'<string>'
],
'vipAuthors' => [
'<string>'
],
'rules' => [
[
'name' => '<string>',
'when' => [
'kind' => 'item',
'all' => [
[
'field' => '<string>',
'value' => '<string>'
]
]
],
'then' => [
[
'channelIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'enabled' => true
]
],
'webhookEvents' => [
],
'channels' => [
[
'channelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'sources' => [
[
'enabled' => true,
'searches' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'label' => '<string>',
'overridesEnabled' => true,
'overrides' => [
'market' => '<string>',
'query' => '<string>',
'priceMin' => 123,
'priceMax' => 123,
'sort' => '<string>',
'page' => 123,
'perPage' => 123,
'filters' => [
],
'terms' => [
'<string>'
],
'repliesTo' => '<string>'
]
]
],
'refreshIntervalSeconds' => 123
]
],
'schedule' => [
'startsAt' => '2023-11-07T05:31:56Z',
'endsAt' => '2023-11-07T05:31:56Z',
'timezone' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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.nephia.cc/v1/keywords/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"refreshIntervalSeconds\": 123,\n \"webhookUrl\": \"\",\n \"aiEnabled\": true,\n \"aiPrompt\": \"<string>\",\n \"aiStep\": {\n \"instruction\": \"<string>\",\n \"schema\": {}\n },\n \"sentimentEnabled\": true,\n \"coBrandsEnabled\": true,\n \"muteRules\": [\n \"<string>\"\n ],\n \"vipAuthors\": [\n \"<string>\"\n ],\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"kind\": \"item\",\n \"all\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"then\": [\n {\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n }\n ],\n \"webhookEvents\": [],\n \"channels\": [\n {\n \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sources\": [\n {\n \"enabled\": true,\n \"searches\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"overridesEnabled\": true,\n \"overrides\": {\n \"market\": \"<string>\",\n \"query\": \"<string>\",\n \"priceMin\": 123,\n \"priceMax\": 123,\n \"sort\": \"<string>\",\n \"page\": 123,\n \"perPage\": 123,\n \"filters\": {},\n \"terms\": [\n \"<string>\"\n ],\n \"repliesTo\": \"<string>\"\n }\n }\n ],\n \"refreshIntervalSeconds\": 123\n }\n ],\n \"schedule\": {\n \"startsAt\": \"2023-11-07T05:31:56Z\",\n \"endsAt\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-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.patch("https://api.nephia.cc/v1/keywords/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"refreshIntervalSeconds\": 123,\n \"webhookUrl\": \"\",\n \"aiEnabled\": true,\n \"aiPrompt\": \"<string>\",\n \"aiStep\": {\n \"instruction\": \"<string>\",\n \"schema\": {}\n },\n \"sentimentEnabled\": true,\n \"coBrandsEnabled\": true,\n \"muteRules\": [\n \"<string>\"\n ],\n \"vipAuthors\": [\n \"<string>\"\n ],\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"kind\": \"item\",\n \"all\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"then\": [\n {\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n }\n ],\n \"webhookEvents\": [],\n \"channels\": [\n {\n \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sources\": [\n {\n \"enabled\": true,\n \"searches\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"overridesEnabled\": true,\n \"overrides\": {\n \"market\": \"<string>\",\n \"query\": \"<string>\",\n \"priceMin\": 123,\n \"priceMax\": 123,\n \"sort\": \"<string>\",\n \"page\": 123,\n \"perPage\": 123,\n \"filters\": {},\n \"terms\": [\n \"<string>\"\n ],\n \"repliesTo\": \"<string>\"\n }\n }\n ],\n \"refreshIntervalSeconds\": 123\n }\n ],\n \"schedule\": {\n \"startsAt\": \"2023-11-07T05:31:56Z\",\n \"endsAt\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nephia.cc/v1/keywords/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"refreshIntervalSeconds\": 123,\n \"webhookUrl\": \"\",\n \"aiEnabled\": true,\n \"aiPrompt\": \"<string>\",\n \"aiStep\": {\n \"instruction\": \"<string>\",\n \"schema\": {}\n },\n \"sentimentEnabled\": true,\n \"coBrandsEnabled\": true,\n \"muteRules\": [\n \"<string>\"\n ],\n \"vipAuthors\": [\n \"<string>\"\n ],\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"when\": {\n \"kind\": \"item\",\n \"all\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"then\": [\n {\n \"channelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true\n }\n ],\n \"webhookEvents\": [],\n \"channels\": [\n {\n \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sources\": [\n {\n \"enabled\": true,\n \"searches\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"overridesEnabled\": true,\n \"overrides\": {\n \"market\": \"<string>\",\n \"query\": \"<string>\",\n \"priceMin\": 123,\n \"priceMax\": 123,\n \"sort\": \"<string>\",\n \"page\": 123,\n \"perPage\": 123,\n \"filters\": {},\n \"terms\": [\n \"<string>\"\n ],\n \"repliesTo\": \"<string>\"\n }\n }\n ],\n \"refreshIntervalSeconds\": 123\n }\n ],\n \"schedule\": {\n \"startsAt\": \"2023-11-07T05:31:56Z\",\n \"endsAt\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"keyword": {
"id": "<string>",
"name": "<string>",
"kind": "catalog",
"globalCriteria": {},
"refreshIntervalSeconds": 123,
"sources": [
{
"source": "x",
"enabled": true,
"searches": [
{
"id": "<string>",
"label": "<string>",
"overridesEnabled": true,
"overrides": {},
"resolvedCriteria": {}
}
],
"refreshIntervalSeconds": 123
}
],
"webhookUrl": "<string>",
"webhookMode": "all",
"webhookEvents": [
"keyword.alert_fired"
],
"aiEnabled": true,
"aiPreset": "<string>",
"aiPrompt": "<string>",
"aiStep": {},
"sentimentEnabled": true,
"coBrandsEnabled": true,
"subjectRole": "own",
"muteRules": [
"<unknown>"
],
"vipAuthors": [
"<unknown>"
],
"rules": [
"<unknown>"
],
"schedule": {},
"isActive": true,
"pausedReason": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
},
"resetSearches": [
{
"source": "x",
"searchId": "<string>",
"label": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "Rate limit exceeded",
"code": "TOO_MANY_REQUESTS"
}Authorizations
API key created from the Nephia dashboard for your Account.
Path Parameters
Body
application/json
Required string length:
1 - 80Seconds between checks. Each Source accepts its own range, published as x-source-intervals at the root of this document. Your plan may raise the floor further; the refusal names the effective one.
Allowed value:
""Available options:
product-model, theme-sentiment, seller, duplicates, custom, null Maximum string length:
400Show child attributes
Show child attributes
Available options:
own, competitor, topic Maximum array length:
50Required string length:
1 - 60Maximum array length:
100Required string length:
1 - 60Maximum array length:
20Show child attributes
Show child attributes
Available options:
all, rules Maximum array length:
5Available options:
keyword.alert_fired, keyword.report_ready, keyword.paused, keyword.resumed, channel.disabled Maximum array length:
5Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum array length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?