radeef.review.apply

Apply the owner's choices on what a reading found: `kept` (proposal ids that become knowledge), `rejected`, `edits`, `merge` (append or replace a topic's text), `follow` (pages to keep reading), `add_pages`, `vanished` (keep or delete); answers the result and the review left.

curl --request POST \
  --url https://tawked.com/v1/applications/{application}/radeef/knowledge/review \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "add_pages": [
    "<string>"
  ],
  "edits": [
    "<unknown>"
  ],
  "follow": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "kept": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "merge": [],
  "rejected": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "scan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vanished": []
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    add_pages: ['<string>'],
    edits: ['<unknown>'],
    follow: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    kept: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    merge: [],
    rejected: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    scan: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    vanished: []
  })
};

fetch('https://tawked.com/v1/applications/{application}/radeef/knowledge/review', 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://tawked.com/v1/applications/{application}/radeef/knowledge/review",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'add_pages' => [
        '<string>'
    ],
    'edits' => [
        '<unknown>'
    ],
    'follow' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'kept' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'merge' => [
        
    ],
    'rejected' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'scan' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'vanished' => [
        
    ]
  ]),
  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;
}

import requests

url = "https://tawked.com/v1/applications/{application}/radeef/knowledge/review"

payload = {
    "add_pages": ["<string>"],
    "edits": ["<unknown>"],
    "follow": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "kept": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "merge": [],
    "rejected": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "scan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vanished": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

POST

applications

{application}

radeef

knowledge

review

curl --request POST \
  --url https://tawked.com/v1/applications/{application}/radeef/knowledge/review \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "add_pages": [
    "<string>"
  ],
  "edits": [
    "<unknown>"
  ],
  "follow": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "kept": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "merge": [],
  "rejected": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "scan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vanished": []
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    add_pages: ['<string>'],
    edits: ['<unknown>'],
    follow: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    kept: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    merge: [],
    rejected: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    scan: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    vanished: []
  })
};

fetch('https://tawked.com/v1/applications/{application}/radeef/knowledge/review', 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://tawked.com/v1/applications/{application}/radeef/knowledge/review",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'add_pages' => [
        '<string>'
    ],
    'edits' => [
        '<unknown>'
    ],
    'follow' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'kept' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'merge' => [
        
    ],
    'rejected' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'scan' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'vanished' => [
        
    ]
  ]),
  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;
}

import requests

url = "https://tawked.com/v1/applications/{application}/radeef/knowledge/review"

payload = {
    "add_pages": ["<string>"],
    "edits": ["<unknown>"],
    "follow": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "kept": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "merge": [],
    "rejected": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "scan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vanished": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

An account token from Settings › Account API in the Tawked console: Authorization: Bearer tk_acct_…

Headers

Idempotency-Key

string

One per intended change (1 to 128 printable ASCII characters): a retry with the same key and the same request answers the stored 2xx with Idempotent-Replayed: true, for 24 hours. A 428 approval_required is never stored: send the approved request again with the same key or none. An answer that carried a secret shown once is never kept: its replay answers 409 idempotency_secret_not_replayable with the id of what it made.

Required string length: 1 - 128

Tawked-Approval

string<uuid>

The id of an approval its person approved (approvals.show answers approved): the same request then runs, once.

Path Parameters

application

string

required

An application's id (a UUID); list them with applications.applications.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$

Body

application/json

add_pages

string[]

Maximum array length: 30

Maximum string length: 2048

edits

any[]

Maximum array length: 200

string<uuid>[]

Maximum array length: 30

kept

string<uuid>[]

Maximum array length: 200

merge

enum<string>[]

Maximum array length: 200

Available options:

append,

replace

rejected

string<uuid>[]

Maximum array length: 200

scan

string<uuid> | null

vanished

enum<string>[]

Maximum array length: 30

Available options:

keep,

delete

Response

Done.

data

object

required