freescout/freescout-support
0
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/rilustrisimo/freescout-support.git synced 2026-04-26 14:02:20 +08:00
Code Issues Projects Packages Activity Actions
freescout-support/Modules/ApiWebhooks/Docs/index.html
Rouie Ilustrisimo 309cac053a slack
2025-05-11 13:59:20 +08:00

3328 lines
No EOL
97 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>FreeScout API Docs</title>
<link rel="stylesheet" href="css/style.css" />
<script src="js/all.js"></script>
<script>
$(function() {
setupLanguages(["javascript","bash","php"]);
});
</script>
</head>
<body class="">
<a href="#" id="nav-button">
<span>
NAV
<img src="images/navbar.png" />
</span>
</a>
<div class="tocify-wrapper">
<img src="images/logo.png" />
<div class="lang-selector">
<a href="#" data-language-name="javascript">javascript</a>
<a href="#" data-language-name="bash">bash</a>
<a href="#" data-language-name="php">php</a>
</div>
<div class="search">
<input type="text" class="search" id="input-search" placeholder="Search">
</div>
<ul class="search-results"></ul>
<div id="toc">
</div>
<ul class="toc-footer">
<li><a href="https://freescout.net" target="_blank">&copy; FreeScout</a></li>
</ul>
</div>
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<!-- START_INFO -->
<h1>Overview</h1>
<h2>Prerequisites</h2>
<p>To enable API in the FreeScout you need to install <a href="https://freescout.net/module/api-webhooks/" target="_blank">API &amp; Webhooks</a> module.</p>
<p>All API requests should be made using UTF-8 encoding.</p>
<h2>Authentication</h2>
<p>API Key can be retrieved in &quot;Manage » API &amp; Webhoks&quot;.</p>
<p>There are three ways to authenticate using API Key to make API calls:</p>
<p>1) Pass API Key in &quot;api_key&quot; GET-parameter:</p>
<p><code><a href="http://demo.freescout.net/api/conversations?api_key=c2ba609c687a3425402b9d881e5075db">http://demo.freescout.net/api/conversations?api_key=c2ba609c687a3425402b9d881e5075db</a></code></p>
<p>2) Pass API Key as a username with a random password via HTTP Basic authentication:</p>
<p><code>Authorization: <strong>c2ba609c687a3425402b9d881e5075db</strong> randompassword</code></p>
<p>3) Pass API Key as &quot;X-FreeScout-API-Key&quot; HTTP header:</p>
<p><code>X-FreeScout-API-Key: <strong>c2ba609c687a3425402b9d881e5075db</strong></code></p>
<h2>HTTP Methods</h2>
<table>
<thead>
<tr>
<th>Method</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>GET</code></td>
<td>Read one or more entities.</td>
</tr>
<tr>
<td><code>POST</code></td>
<td>Create new entity.</td>
</tr>
<tr>
<td><code>DELETE</code></td>
<td>Delete single entity.</td>
</tr>
<tr>
<td><code>OPTIONS</code></td>
<td>Returns allowed HTTP methods and <code>Access-Control-*</code> headers for <code>CORS</code> preflight request.</td>
</tr>
</tbody>
</table>
<h2>Status Codes</h2>
<table>
<thead>
<tr>
<th>Status Code</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>200</code></td>
<td>OK</td>
<td>Request was successful and response contains data.</td>
</tr>
<tr>
<td><code>201</code></td>
<td>Created</td>
<td>Resource was created. Response will contain either <code>Location</code> header or <code>Resource-ID</code> header. Usually for <code>POST</code> requests.</td>
</tr>
<tr>
<td><code>204</code></td>
<td>No Content</td>
<td>Request was successful and response is empty. Typical response for <code>PUT</code>, <code>PATCH</code> and <code>DELETE</code> requests.</td>
</tr>
<tr>
<td><code>301</code></td>
<td>Moved permanently</td>
<td>Requested entity existed under a different ID or path. Check the <code>Location</code> header.</td>
</tr>
<tr>
<td><code>400</code></td>
<td>Bad Request</td>
<td>Client error - the request doesn’t meet all requirements, see <a href="#errors">error messages</a>.</td>
</tr>
<tr>
<td><code>401</code></td>
<td>Not Authorized</td>
<td>API Key is either not provided or not valid.</td>
</tr>
<tr>
<td><code>403</code></td>
<td>Access denied</td>
<td>Your API Key is valid, but you are denied access - the response should contain details.</td>
</tr>
<tr>
<td><code>404</code></td>
<td>Not Found</td>
<td>Resource was not found - it doesn’t exist or it was deleted.</td>
</tr>
<tr>
<td><code>405</code></td>
<td>Method Not Allowed</td>
<td>This error indicates that you are using incorrect HTTP method or incorrect API endpoint URL (allowed HTTP methods are URLs are described in this documentation for each API method) or you need to update API & Webhooks Module to the latest version (in older versions not all API methods were present).</td>
</tr>
<tr>
<td><code>409</code></td>
<td>Conflict</td>
<td>Resource cannot be created because conflicting entity already exists.</td>
</tr>
<tr>
<td><code>412</code></td>
<td>Precondition failed</td>
<td>The request was well formed and valid, but some other conditions were not met.</td>
</tr>
<tr>
<td><code>413</code></td>
<td>Request Entity Too Large</td>
<td>The payload of the request is larger than limit of the <a href="https://www.cyberciti.biz/faq/linux-unix-bsd-nginx-413-request-entity-too-large/" target="_blank" rel="nofollow">web server or PHP</a>.</td>
</tr>
<tr>
<td><code>415</code></td>
<td>Unsupported Media Type</td>
<td>The API is unable to work with the provided payload.</td>
</tr>
<tr>
<td><code>500</code></td>
<td>Internal Server Error</td>
<td>Whoops, looks like something went wrong on our end.</td>
</tr>
<tr>
<td><code>504</code></td>
<td>Gateway Timeout</td>
<td>The API call timed-out. It is safe to retry the request after a short delay.</td>
</tr>
</tbody>
</table>
<h2>Date Format</h2>
<p>All dates in the API are displayed and expected to be in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="nofollow">ISO 8601</a> format in the UTC timezone:<br/>
<code>YYYY-MM-DDThh:mm:ssZ</code> (&quot;Z&quot; is the designator for the zero UTC offset).</p>
<p>Example: <code>2020-01-02T23:00:00Z</code></p>
<h2>Errors</h2>
<p>Example of the error response is presented on the right side (or below).</p>
<pre>
<code class="language-bash hljs">
{
"message": "Bad request",
"errorCode": "BAD REQUEST",
"_embedded": {
"errors": [
{
"path": "subject",
"message": "may not be empty",
"source": "JSON"
},
{
"path": "status",
"message": "Expected one of these: 'active', 'spam', 'open', 'closed', 'pending'",
"rejectedValue": "Wrong",
"source": "JSON"
}
]
}
}
</code>
</pre>
<pre>
<code class="language-javascript hljs">
{
"message": "Bad request",
"errorCode": "BAD REQUEST",
"_embedded": {
"errors": [
{
"path": "subject",
"message": "may not be empty",
"source": "JSON"
},
{
"path": "status",
"message": "Expected one of these: 'active', 'spam', 'open', 'closed', 'pending'",
"rejectedValue": "Wrong",
"source": "JSON"
}
]
}
}
</code>
</pre>
<pre>
<code class="language-php hljs">
{
"message": "Bad request",
"_embedded": {
"errors": [
{
"path": "subject",
"message": "may not be empty",
"source": "JSON"
},
{
"path": "status",
"message": "Expected one of these: 'active', 'spam', 'open', 'closed', 'pending'",
"rejectedValue": "Wrong",
"source": "JSON"
}
]
}
}
</code>
</pre>
<!-- END_INFO -->
<h1>Conversations</h1>
<!-- START_1d6ac3c69bc5f2271b33806815418dc6 -->
<h2>Create Conversation</h2>
<p>This method creates a conversation in a mailbox with at least one thread.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"type": "email",
"mailboxId": 1,
"subject": "Hi there",
"customer": {
"email": "mark@example.org"
},
"threads": [
{
"text": "This is the message from a user",
"type": "message",
"user": 7
},
{
"text": "This is the note from a user",
"type": "note",
"user": 7
},
{
"text": "This is the message from a customer",
"type": "customer",
"cc": [
"antony@example.org"
],
"customer": {
"email": "mark@example.org",
"firstName": "Mark"
}
}
],
"imported": false,
"assignTo": 15,
"status": "active",
"customFields": [
{
"id": 37,
"value": "Some text"
},
{
"id": 18,
"value": 3
}
],
"createdAt": "2020-03-16T14:07:23Z",
"closedAt": "2020-03-16T14:07:23Z"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X POST "https://demo.freescout.net/api/conversations" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"type":"email","mailboxId":1,"subject":"Hi there","customer":{"email":"mark@example.org"},"threads":[{"text":"This is the message from a user","type":"message","user":7},{"text":"This is the note from a user","type":"note","user":7},{"text":"This is the message from a customer","type":"customer","cc":["antony@example.org"],"customer":{"email":"mark@example.org","firstName":"Mark"}}],"imported":false,"assignTo":15,"status":"active","customFields":[{"id":37,"value":"Some text"},{"id":18,"value":3}],"createdAt":"2020-03-16T14:07:23Z","closedAt":"2020-03-16T14:07:23Z"}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;post("https://demo.freescout.net/api/conversations", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"type" =&gt; "email",
"mailboxId" =&gt; "1",
"subject" =&gt; "Hi there",
"customer" =&gt; array(
'email' =&gt; 'mark@example.org',
),
"threads" =&gt; array (
0 =&gt;
array(
'text' =&gt; 'This is the message from a user',
'type' =&gt; 'message',
'user' =&gt; 7,
),
1 =&gt;
array(
'text' =&gt; 'This is the note from a user',
'type' =&gt; 'note',
'user' =&gt; 7,
),
2 =&gt;
array(
'text' =&gt; 'This is the message from a customer',
'type' =&gt; 'customer',
'cc' =&gt;
array (
0 =&gt; 'antony@example.org',
),
'customer' =&gt;
array(
'email' =&gt; 'mark@example.org',
'firstName' =&gt; 'Mark',
),
),
),
"imported" =&gt; "",
"assignTo" =&gt; "15",
"status" =&gt; "active",
"customFields" =&gt; array (
0 =&gt;
array(
'id' =&gt; 37,
'value' =&gt; 'Some text',
),
1 =&gt;
array(
'id' =&gt; 18,
'value' =&gt; 3,
),
),
"createdAt" =&gt; "2020-03-16T14:07:23Z",
"closedAt" =&gt; "2020-03-16T14:07:23Z",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 201 Created
Resource-ID: 35</code></pre>
<h3>HTTP Request</h3>
<p><code>POST api/conversations</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>string</td>
<td>(required)</td>
<td>Conversation type: email, phone, chat (after importing &quot;chat&quot; conversation, support agent replies will not reach customer linked to the conversation, as connection to customer's messenger can't be imported).</td>
</tr>
<tr>
<td>mailboxId</td>
<td>number</td>
<td>(required)</td>
<td>ID of a mailbox where the conversation is being created.</td>
</tr>
<tr>
<td>subject</td>
<td>string</td>
<td>(required)</td>
<td>Conversation’s subject.</td>
</tr>
<tr>
<td>customer</td>
<td>object</td>
<td>(required)</td>
<td>Customer associated with the conversation. Customer object must contain a valid customer id or an email address: { &quot;id&quot;: 123 } or { &quot;email&quot;: &quot;mark@example.org&quot; }. If the id field is defined, the email will be ignored. If the id is not defined, email is used to look up a customer. If a customer does not exist, a new one will be created. If a customer is matched either via id or email field, the rest of the optional fields is ignored. When creating a phone conversation &quot;firstName&quot; or &quot;phone&quot; can be passed instead of &quot;email&quot;.</td>
</tr>
<tr>
<td>threads</td>
<td>object</td>
<td>(required)</td>
<td>Conversation threads. There has to be least one thread in a conversation. Newest threads go first.</td>
</tr>
<tr>
<td>imported</td>
<td>boolean</td>
<td></td>
<td>When imported is set to true (boolean value without quotes), no outgoing emails or notifications will be generated, auto reply will not be sent to the customer.</td>
</tr>
<tr>
<td>assignTo</td>
<td>number</td>
<td></td>
<td>User ID to assign new conversation to.</td>
</tr>
<tr>
<td>status</td>
<td>string</td>
<td></td>
<td>Conversation status: active, pending, closed.</td>
</tr>
<tr>
<td>customFields</td>
<td>object</td>
<td></td>
<td>Conversation custom fields.</td>
</tr>
<tr>
<td>createdAt</td>
<td>string</td>
<td></td>
<td>Conversation date (ISO 8601 date time format).</td>
</tr>
<tr>
<td>closedAt</td>
<td>string</td>
<td></td>
<td>When the conversation was closed, only applicable for imported conversations (ISO 8601 date time format).</td>
</tr>
</tbody>
</table>
<!-- END_1d6ac3c69bc5f2271b33806815418dc6 -->
<!-- START_7eb9046b1022373c1e9cab182bfc71a9 -->
<h2>Get Conversation</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations/1");
let params = {
"embed": "threads",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/conversations/1?embed=threads" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/conversations/1", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"embed" =&gt; "threads",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (200):</p>
</blockquote>
<pre><code class="language-json">{
"id": 1,
"number": 3,
"threadsCount": 2,
"type": "email",
"folderId": 11,
"status": "closed",
"state": "published",
"subject": "Refund",
"preview": "Could you please refund my recent payment...",
"mailboxId": 15,
"assignee": {
"id": 9,
"type": "user",
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@example.org"
},
"createdBy": {
"id": 11,
"type": "customer",
"email": "customer@example.org"
},
"createdAt": "2020-03-15T22:46:22Z",
"updatedAt": "2020-03-15T22:46:22Z",
"closedBy": 14,
"closedByUser": {
"id": 14,
"type": "user",
"firstName": "John",
"lastName": "Doe",
"photoUrl": "https:\/\/support.example.org\/storage\/users\/5a10629fd2bae86563892b191f6677e7.jpg",
"email": "johndoe@example.org"
},
"closedAt": "2020-03-16T14:07:23Z",
"userUpdatedAt": "2020-03-16T14:07:23Z",
"customerWaitingSince": {
"time": "2020-07-24T20:18:33Z",
"friendly": "10 hours ago",
"latestReplyFrom": "customer"
},
"source": {
"type": "email",
"via": "customer"
},
"cc": [
"fox@example.org"
],
"bcc": [
"fox@example.org"
],
"customer": {
"id": 91,
"type": "customer",
"firstName": "Rodney",
"lastName": "Robertson",
"photoUrl": "https:\/\/support.example.org\/storage\/customers\/7a10629fd2bae86563892b191f6677e7.jpg",
"email": "rodney@example.org"
},
"customFields": [
{
"id": 22,
"name": "Amount",
"value": "7",
"text": ""
},
{
"id": 23,
"name": "Currency",
"value": "1",
"text": "USD"
}
],
"_embedded": {
"threads": [
{
"id": 17,
"type": "customer",
"status": "active",
"state": "published",
"action": {
"type": "changed-ticket-assignee",
"text": "John Doe assigned conversation to Mark",
"associatedEntities": []
},
"body": "Thank you very much!",
"source": {
"type": "email",
"via": "customer"
},
"customer": {
"id": 91,
"type": "customer",
"firstName": "Rodney",
"lastName": "Robertson",
"photoUrl": "https:\/\/support.example.org\/storage\/customers\/7a10629fd2bae86563892b191f6677e7.jpg",
"email": "rodney@example.org"
},
"createdBy": {
"id": 91,
"type": "customer",
"firstName": "Rodney",
"lastName": "Robertson",
"photoUrl": "https:\/\/support.example.org\/storage\/customers\/7a10629fd2bae86563892b191f6677e7.jpg",
"email": "rodney@example.org"
},
"assignedTo": {
"id": 14,
"type": "user",
"firstName": "John",
"lastName": "Doe",
"photoUrl": "https:\/\/support.example.org\/storage\/users\/5a10629fd2bae86563892b191f6677e7.jpg",
"email": "johndoe@example.org"
},
"to": [
"test@example.org"
],
"cc": [
"fox@example.org"
],
"bcc": [
"fox@example.org"
],
"createdAt": "2020-06-05T20:18:33Z",
"openedAt": "2020-06-07T10:01:25Z",
"_embedded": {
"attachments": [
{
"id": 71,
"fileName": "example.pdf",
"fileUrl": "https:\/\/support.example.org\/storage\/attachment\/7\/3\/1\/example.pdf?id=71&amp;token=c5135450a05cc47d7aa3333d8a3e7831",
"mimeType": "application\/pdf",
"size": 2331
}
]
}
}
],
"timelogs": [
{
"id": 498,
"conversationStatus": "pending",
"userId": 1,
"timeSpent": 219,
"paused": false,
"finished": true,
"createdAt": "2021-04-21T13-24-01Z",
"updatedAt": "2021-04-21T13-43-10Z"
},
{
"id": 497,
"conversationId": 1984,
"conversationStatus": "active",
"userId": 1,
"timeSpent": 711,
"paused": false,
"finished": true,
"createdAt": "2021-04-21T13-22-09Z",
"updatedAt": "2021-04-21T13-43-10Z"
}
],
"tags": [
{
"id": 57,
"name": "overdue"
},
{
"id": 39,
"name": "refund"
}
]
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/conversations/{conversationId}</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>embed</td>
<td></td>
<td>Pass comma separated values to include extra data: threads, timelogs, tags. Default: threads.</td>
</tr>
</tbody>
</table>
<!-- END_7eb9046b1022373c1e9cab182bfc71a9 -->
<!-- START_50f5969ffa4376ab4d09a74616534468 -->
<h2>List Conversations</h2>
<p>Request parameters can be used to filter conversations. By default conversations are sorted by createdAt (from newest to oldest): ?sortField=createdAt&amp;sortOrder=desc</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations");
let params = {
"embed": "threads",
"mailboxId": "123",
"folderId": "57",
"status": "active",
"state": "deleted",
"type": "email",
"assignedTo": "35",
"customerEmail": "john@example.org",
"customerPhone": "777-777-777",
"customerId": "17",
"number": "359",
"subject": "test",
"tag": "overdue",
"createdByUserId": "9",
"createdByCustomerId": "10",
"createdSince": "2021-01-07T12:00:03Z",
"updatedSince": "2021-01-07T12:00:03Z",
"sortField": "updatedAt",
"sortOrder": "asc",
"page": "1",
"pageSize": "100",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/conversations?embed=threads&amp;mailboxId=123&amp;folderId=57&amp;status=active&amp;state=deleted&amp;type=email&amp;assignedTo=35&amp;customerEmail=john%40example.org&amp;customerPhone=777-777-777&amp;customerId=17&amp;number=359&amp;subject=test&amp;tag=overdue&amp;createdByUserId=9&amp;createdByCustomerId=10&amp;createdSince=2021-01-07T12%3A00%3A03Z&amp;updatedSince=2021-01-07T12%3A00%3A03Z&amp;sortField=updatedAt&amp;sortOrder=asc&amp;page=1&amp;pageSize=100" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/conversations", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"embed" =&gt; "threads",
"mailboxId" =&gt; "123",
"folderId" =&gt; "57",
"status" =&gt; "active",
"state" =&gt; "deleted",
"type" =&gt; "email",
"assignedTo" =&gt; "35",
"customerEmail" =&gt; "john@example.org",
"customerPhone" =&gt; "777-777-777",
"customerId" =&gt; "17",
"number" =&gt; "359",
"subject" =&gt; "test",
"tag" =&gt; "overdue",
"createdByUserId" =&gt; "9",
"createdByCustomerId" =&gt; "10",
"createdSince" =&gt; "2021-01-07T12:00:03Z",
"updatedSince" =&gt; "2021-01-07T12:00:03Z",
"sortField" =&gt; "updatedAt",
"sortOrder" =&gt; "asc",
"page" =&gt; "1",
"pageSize" =&gt; "100",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">{
"_embedded": {
"conversations": [
{
"id": 1,
"number": 3,
"threads": 2,
"type": "email",
"folderId": 11,
"status": "closed",
"state": "published",
"subject": "Refund",
"preview": "Could you please refund my recent payment...",
"mailboxId": 15,
"assignee": {
"id": 9,
"type": "user",
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@example.org"
},
"createdBy": {
"id": 11,
"type": "customer",
"email": "customer@example.org"
},
"createdAt": "2020-03-15T22:46:22Z",
"updatedAt": "2020-03-15T22:46:22Z",
"closedBy": 14,
"closedByUser": {
"id": 14,
"type": "user",
"firstName": "John",
"lastName": "Doe",
"photoUrl": "https:\/\/support.example.org\/storage\/users\/5a10629fd2bae86563892b191f6677e7.jpg",
"email": "johndoe@example.org"
},
"closedAt": "2020-03-16T14:07:23Z",
"userUpdatedAt": "2020-03-16T14:07:23Z",
"customerWaitingSince": {
"time": "2020-07-24T20:18:33Z",
"friendly": "10 hours ago",
"latestReplyFrom": "customer"
},
"source": {
"type": "email",
"via": "customer"
},
"cc": [
"fox@example.org"
],
"bcc": [
"fox@example.org"
],
"customer": {
"id": 91,
"type": "customer",
"firstName": "Rodney",
"lastName": "Robertson",
"photoUrl": "https:\/\/support.example.org\/storage\/customers\/7a10629fd2bae86563892b191f6677e7.jpg",
"email": "rodney@example.org"
},
"customFields": [],
"_embedded": {
"threads": []
}
}
]
},
"page": {
"size": 50,
"totalElements": 1,
"totalPages": 1,
"number": 1
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/conversations</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>embed</td>
<td></td>
<td>Pass comma separated values to include extra data: threads, timelogs, tags.</td>
</tr>
<tr>
<td>mailboxId</td>
<td></td>
<td>Filter conversations from a specific mailbox. Can contain multiple comma separated IDs.</td>
</tr>
<tr>
<td>folderId</td>
<td></td>
<td>Filter conversations from a specific folder ID (filtering by Custom Folder ID provided by Custom Folders Module is not possible).</td>
</tr>
<tr>
<td>status</td>
<td></td>
<td>Filter conversation by status (defaults to active): active, pending, closed, spam. Can contain multiple comma separated values.</td>
</tr>
<tr>
<td>state</td>
<td></td>
<td>Filter conversation by state: draft, published, deleted.</td>
</tr>
<tr>
<td>type</td>
<td></td>
<td>Filter conversation by type: email, phone, chat.</td>
</tr>
<tr>
<td>assignedTo</td>
<td></td>
<td>Filter conversations by assignee id. Pass an empty value in order to get unassigned conversations.</td>
</tr>
<tr>
<td>customerEmail</td>
<td></td>
<td>Filter conversations by customer email.</td>
</tr>
<tr>
<td>customerPhone</td>
<td></td>
<td>Filter conversations by customer phone number.</td>
</tr>
<tr>
<td>customerId</td>
<td></td>
<td>Filter conversations by customer ID.</td>
</tr>
<tr>
<td>number</td>
<td></td>
<td>Look up conversation by conversation number.</td>
</tr>
<tr>
<td>subject</td>
<td></td>
<td>Look up conversations containing a text in the subject.</td>
</tr>
<tr>
<td>tag</td>
<td></td>
<td>Look up conversations by tag.</td>
</tr>
<tr>
<td>createdByUserId</td>
<td></td>
<td>Filter conversations by a user who created it.</td>
</tr>
<tr>
<td>createdByCustomerId</td>
<td></td>
<td>Filter conversations by a customer who created it.</td>
</tr>
<tr>
<td>createdSince</td>
<td></td>
<td>Return only conversations created after the specified date.</td>
</tr>
<tr>
<td>updatedSince</td>
<td></td>
<td>Return only conversations modified after the specified date.</td>
</tr>
<tr>
<td>sortField</td>
<td></td>
<td>Sort the result by specified field: createdAt, mailboxId, number, subject, updatedAt, waitingSince.</td>
</tr>
<tr>
<td>sortOrder</td>
<td></td>
<td>Sort order: desc (default), asc.</td>
</tr>
<tr>
<td>page</td>
<td></td>
<td>Page number.</td>
</tr>
<tr>
<td>pageSize</td>
<td></td>
<td>Page size (defaults to 50).</td>
</tr>
</tbody>
</table>
<!-- END_50f5969ffa4376ab4d09a74616534468 -->
<!-- START_9af4092fc65bbb7be5b27a76d35ddaa8 -->
<h2>Update Conversation</h2>
<p>Order of passed parameters (status, assignTo, etc.) determines the order in which changes are made.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations/1");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"byUser": 33,
"status": "active",
"assignTo": 15,
"mailboxId": 1,
"customerId": 7,
"subject": 0
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X PUT "https://demo.freescout.net/api/conversations/1" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"byUser":33,"status":"active","assignTo":15,"mailboxId":1,"customerId":7,"subject":0}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;put("https://demo.freescout.net/api/conversations/1", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"byUser" =&gt; "33",
"status" =&gt; "active",
"assignTo" =&gt; "15",
"mailboxId" =&gt; "1",
"customerId" =&gt; "7",
"subject" =&gt; "0",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (204):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 204 No Content</code></pre>
<h3>HTTP Request</h3>
<p><code>PUT api/conversations/{conversationId}</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>byUser</td>
<td>number</td>
<td></td>
<td>ID of the user updating the conversation. Required when changing: &quot;status&quot;, &quot;assignTo&quot; or &quot;mailboxId&quot;.</td>
</tr>
<tr>
<td>status</td>
<td>string</td>
<td></td>
<td>Change conversation status: active, pending, closed, spam.</td>
</tr>
<tr>
<td>assignTo</td>
<td>number</td>
<td></td>
<td>Change conversation assignee to the user with the specified ID.</td>
</tr>
<tr>
<td>mailboxId</td>
<td>number</td>
<td></td>
<td>Move conversation to the mailbox with the specified ID.</td>
</tr>
<tr>
<td>customerId</td>
<td>number</td>
<td></td>
<td>Change conversation customer to the customer with the specified ID.</td>
</tr>
<tr>
<td>subject</td>
<td>number</td>
<td></td>
<td>Change conversation subject.</td>
</tr>
</tbody>
</table>
<!-- END_9af4092fc65bbb7be5b27a76d35ddaa8 -->
<!-- START_4707936ff528253a44af8ffa61aac295 -->
<h2>Delete Conversation</h2>
<p>This method deletes a conversation forever.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations/1");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X DELETE "https://demo.freescout.net/api/conversations/1" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;delete("https://demo.freescout.net/api/conversations/1", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (204):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 204 No Content</code></pre>
<h3>HTTP Request</h3>
<p><code>DELETE api/conversations/{conversationId}</code></p>
<!-- END_4707936ff528253a44af8ffa61aac295 -->
<h1>Custom Fields</h1>
<!-- START_e8e93ef443c404f9ef8d0aa18adf6ac3 -->
<h2>Update Custom Fields</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations/1/custom_fields");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"customFields": [
{
"id": 37,
"value": "Test value"
}
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X PUT "https://demo.freescout.net/api/conversations/1/custom_fields" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"customFields":[{"id":37,"value":"Test value"}]}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;put("https://demo.freescout.net/api/conversations/1/custom_fields", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"customFields" =&gt; array (
0 =&gt;
array(
'id' =&gt; 37,
'value' =&gt; 'Test value',
),
),
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (204):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 204 No Content</code></pre>
<h3>HTTP Request</h3>
<p><code>PUT api/conversations/{conversationId}/custom_fields</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>customFields</td>
<td>array</td>
<td>(required)</td>
<td>List of custom fields to be applied to the conversation. When updating a custom filed with type &quot;Dropdown&quot;, in the value field you must provide a number (ID), not a textual value.</td>
</tr>
</tbody>
</table>
<!-- END_e8e93ef443c404f9ef8d0aa18adf6ac3 -->
<h1>Customers</h1>
<!-- START_089467e7ea475fb2aca445b2d23f6e7d -->
<h2>Create Customer</h2>
<p>This method does not update existing customers. Method makes sure that the email address is unique and does not check uniqueness of other parameters. If the request contains email(s) and customers with all these emails already exist, no customer will be created.</p>
<p>If want to avoid creating duplicate customers with same &quot;firstName&quot;, &quot;lastName&quot; and &quot;phone&quot;, before executing this method use &quot;List Customers&quot; method to check if the customer already exists.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/customers");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"firstName": "Mark",
"lastName": "Morrison",
"phone": "777-777-777",
"photoUrl": "https:\/\/example.org\/upload\/customer.jpg",
"jobTitle": "Secretary",
"photoType": "unknown",
"address": {
"city": "LA",
"state": "California",
"zip": "123123",
"country": "US",
"address": "1419 Westwood Blvd"
},
"notes": "Nothing special to say",
"company": "Example, Inc",
"emails": [
{
"value": "mark@example.org",
"type": "home"
}
],
"phones": [
{
"value": "777-777-777",
"type": "home"
}
],
"socialProfiles": [
{
"value": "@markexample",
"type": "twitter"
}
],
"websites": [
{
"value": "https:\/\/example.org"
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X POST "https://demo.freescout.net/api/customers" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"firstName":"Mark","lastName":"Morrison","phone":"777-777-777","photoUrl":"https:\/\/example.org\/upload\/customer.jpg","jobTitle":"Secretary","photoType":"unknown","address":{"city":"LA","state":"California","zip":"123123","country":"US","address":"1419 Westwood Blvd"},"notes":"Nothing special to say","company":"Example, Inc","emails":[{"value":"mark@example.org","type":"home"}],"phones":[{"value":"777-777-777","type":"home"}],"socialProfiles":[{"value":"@markexample","type":"twitter"}],"websites":[{"value":"https:\/\/example.org"}]}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;post("https://demo.freescout.net/api/customers", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"firstName" =&gt; "Mark",
"lastName" =&gt; "Morrison",
"phone" =&gt; "777-777-777",
"photoUrl" =&gt; "https://example.org/upload/customer.jpg",
"jobTitle" =&gt; "Secretary",
"photoType" =&gt; "unknown",
"address" =&gt; array(
'city' =&gt; 'LA',
'state' =&gt; 'California',
'zip' =&gt; '123123',
'country' =&gt; 'US',
'address' =&gt; '1419 Westwood Blvd',
),
"notes" =&gt; "Nothing special to say",
"company" =&gt; "Example, Inc",
"emails" =&gt; array (
0 =&gt;
array(
'value' =&gt; 'mark@example.org',
'type' =&gt; 'home',
),
),
"phones" =&gt; array (
0 =&gt;
array(
'value' =&gt; '777-777-777',
'type' =&gt; 'home',
),
),
"socialProfiles" =&gt; array (
0 =&gt;
array(
'value' =&gt; '@markexample',
'type' =&gt; 'twitter',
),
),
"websites" =&gt; array (
0 =&gt;
array(
'value' =&gt; 'https://example.org',
),
),
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 201 Created
Resource-ID: 17</code></pre>
<h3>HTTP Request</h3>
<p><code>POST api/customers</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>firstName</td>
<td>string</td>
<td></td>
<td>First name of the customer (max 40 characters).</td>
</tr>
<tr>
<td>lastName</td>
<td>string</td>
<td></td>
<td>Last name of the customer (max 40 characters).</td>
</tr>
<tr>
<td>phone</td>
<td>string</td>
<td></td>
<td>Phone number.</td>
</tr>
<tr>
<td>photoUrl</td>
<td>string</td>
<td></td>
<td>URL of the customer’s photo (max 200 characters).</td>
</tr>
<tr>
<td>jobTitle</td>
<td>string</td>
<td></td>
<td>Job title (max 60 characters).</td>
</tr>
<tr>
<td>photoType</td>
<td>string</td>
<td></td>
<td>Type of photo: unknown, gravatar, twitter, facebook, googleprofile, googleplus, linkedin.</td>
</tr>
<tr>
<td>address</td>
<td>object</td>
<td></td>
<td>Customer's address (country contains <a href="https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes" target="_blank" rel="nofollow">two-letter country code</a>): { &quot;city&quot;: &quot;Los Angeles&quot;, &quot;state&quot;: &quot;California&quot;, &quot;zip&quot;: &quot;123123&quot;, &quot;country&quot;: &quot;US&quot;, &quot;address&quot;: &quot;1419 Westwood Blvd&quot; }.</td>
</tr>
<tr>
<td>notes</td>
<td>string</td>
<td></td>
<td>Notes.</td>
</tr>
<tr>
<td>company</td>
<td>string</td>
<td></td>
<td>Company (max 60 characters).</td>
</tr>
<tr>
<td>emails</td>
<td>object</td>
<td></td>
<td>List of email entries: [ { &quot;value&quot;: &quot;mark@example.org&quot;, &quot;type&quot;: &quot;home&quot; } ].</td>
</tr>
<tr>
<td>phones</td>
<td>object</td>
<td></td>
<td>List of phones entries: [ { &quot;value&quot;: &quot;777-777-777&quot;, &quot;type&quot;: &quot;home&quot; } ].</td>
</tr>
<tr>
<td>socialProfiles</td>
<td>object</td>
<td></td>
<td>List of social profile entries: [ { &quot;value&quot;: &quot;@markexample&quot;, &quot;type&quot;: &quot;twitter&quot; } ].</td>
</tr>
<tr>
<td>websites</td>
<td>object</td>
<td></td>
<td>List of website entries: [ { &quot;value&quot;: &quot;https:\/\/example.org&quot; } ].</td>
</tr>
</tbody>
</table>
<!-- END_089467e7ea475fb2aca445b2d23f6e7d -->
<!-- START_f5555906b7b3e8fc19c9d95b2ae1bb4d -->
<h2>Get Customer</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/customers/1");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/customers/1" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/customers/1", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (200):</p>
</blockquote>
<pre><code class="language-json">{
"id": 75,
"firstName": "Mark",
"lastName": "Morrison",
"company": "Example, Inc",
"jobTitle": "Secretary",
"photoType": "unknown",
"photoUrl": "https:\/\/support.example.org\/storage\/customers\/7a10629fd2bae86563892b191f6677e7.jpg",
"createdAt": "2020-07-23T12:34:12Z",
"updatedAt": "2020-07-24T20:18:33Z",
"notes": "Nothing special to say.",
"customerFields": [
{
"id": 11,
"name": "Age",
"value": "25",
"text": ""
},
{
"id": 2,
"name": "Gender",
"value": "1",
"text": "Male"
}
],
"_embedded": {
"emails": [
{
"id": 1,
"value": "mark@example.org",
"type": "home"
}
],
"phones": [
{
"id": 0,
"value": "777-777-777",
"type": "home"
}
],
"social_profiles": [
{
"id": 0,
"value": "@markexample",
"type": "twitter"
}
],
"websites": [
{
"id": 0,
"value": "https:\/\/example.org"
}
],
"address": {
"city": "Los Angeles",
"state": "California",
"zip": "123123",
"country": "US",
"address": "1419 Westwood Blvd"
}
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/customers/{customerId}</code></p>
<!-- END_f5555906b7b3e8fc19c9d95b2ae1bb4d -->
<!-- START_96ed66d9e6531df9b49e02d84ca5a619 -->
<h2>List Customers</h2>
<p>Request parameters can be used to filter customers. By default customers are sorted by createdAt (from newest to oldest): ?sortField=createdAt&amp;sortOrder=desc</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/customers");
let params = {
"firstName": "John",
"lastName": "Doe",
"phone": "777-777-777",
"email": "john@example.org",
"updatedSince": "2021-01-07T12:00:03Z",
"sortField": "firstName",
"sortOrder": "asc",
"page": "1",
"pageSize": "100",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/customers?firstName=John&amp;lastName=Doe&amp;phone=777-777-777&amp;email=john%40example.org&amp;updatedSince=2021-01-07T12%3A00%3A03Z&amp;sortField=firstName&amp;sortOrder=asc&amp;page=1&amp;pageSize=100" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/customers", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"firstName" =&gt; "John",
"lastName" =&gt; "Doe",
"phone" =&gt; "777-777-777",
"email" =&gt; "john@example.org",
"updatedSince" =&gt; "2021-01-07T12:00:03Z",
"sortField" =&gt; "firstName",
"sortOrder" =&gt; "asc",
"page" =&gt; "1",
"pageSize" =&gt; "100",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">{
"_embedded": {
"customers": [
{
"id": 75,
"firstName": "Mark",
"lastName": "Morrison",
"company": "Example, Inc",
"jobTitle": "Secretary",
"photoType": "unknown",
"photoUrl": "https:\/\/support.example.org\/storage\/customers\/7a10629fd2bae86563892b191f6677e7.jpg",
"createdAt": "2020-07-23T12:34:12Z",
"updatedAt": "2020-07-24T20:18:33Z",
"notes": "Nothing special to say.",
"_embedded": {
"emails": [],
"phones": [],
"social_profiles": [],
"websites": [],
"address": {
"city": null,
"state": null,
"zip": null,
"country": null,
"address": null
}
}
}
]
},
"page": {
"size": 50,
"totalElements": 1,
"totalPages": 1,
"number": 1
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/customers</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>firstName</td>
<td></td>
<td>Filter customers by first name.</td>
</tr>
<tr>
<td>lastName</td>
<td></td>
<td>Filter customers by last name.</td>
</tr>
<tr>
<td>phone</td>
<td></td>
<td>Filter customers by phone number.</td>
</tr>
<tr>
<td>email</td>
<td></td>
<td>Filter customers by email.</td>
</tr>
<tr>
<td>updatedSince</td>
<td></td>
<td>Return only customers modified after the specified date.</td>
</tr>
<tr>
<td>sortField</td>
<td></td>
<td>Sort the result by specified field: createdAt (default), firstName, lastName, updatedAt.</td>
</tr>
<tr>
<td>sortOrder</td>
<td></td>
<td>Sort order: desc (default), asc.</td>
</tr>
<tr>
<td>page</td>
<td></td>
<td>Page number.</td>
</tr>
<tr>
<td>pageSize</td>
<td></td>
<td>Page size (defaults to 50).</td>
</tr>
</tbody>
</table>
<!-- END_96ed66d9e6531df9b49e02d84ca5a619 -->
<!-- START_cc9faa85d22f6ac8472d46eebdabafe6 -->
<h2>Update Customer</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/customers/1");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"firstName": "Mark",
"lastName": "Morrison",
"phone": "777-777-777",
"photoUrl": "https:\/\/example.org\/upload\/customer.jpg",
"jobTitle": "Secretary",
"photoType": "unknown",
"address": {
"city": "LA",
"state": "California",
"zip": "123123",
"country": "US",
"address": "1419 Westwood Blvd"
},
"notes": "Nothing special to say",
"company": "Example, Inc",
"emails": [
"mark@example.org",
"admin@example.org"
],
"emails_add": [
"mark.new1@example.org",
"mark.new2@example.org"
],
"phones": [
{
"value": "777-777-777",
"type": "home"
}
],
"socialProfiles": [
{
"value": "@markexample",
"type": "twitter"
}
],
"websites": [
{
"value": "https:\/\/example.org"
}
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X PUT "https://demo.freescout.net/api/customers/1" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"firstName":"Mark","lastName":"Morrison","phone":"777-777-777","photoUrl":"https:\/\/example.org\/upload\/customer.jpg","jobTitle":"Secretary","photoType":"unknown","address":{"city":"LA","state":"California","zip":"123123","country":"US","address":"1419 Westwood Blvd"},"notes":"Nothing special to say","company":"Example, Inc","emails":["mark@example.org","admin@example.org"],"emails_add":["mark.new1@example.org","mark.new2@example.org"],"phones":[{"value":"777-777-777","type":"home"}],"socialProfiles":[{"value":"@markexample","type":"twitter"}],"websites":[{"value":"https:\/\/example.org"}]}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;put("https://demo.freescout.net/api/customers/1", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"firstName" =&gt; "Mark",
"lastName" =&gt; "Morrison",
"phone" =&gt; "777-777-777",
"photoUrl" =&gt; "https://example.org/upload/customer.jpg",
"jobTitle" =&gt; "Secretary",
"photoType" =&gt; "unknown",
"address" =&gt; array(
'city' =&gt; 'LA',
'state' =&gt; 'California',
'zip' =&gt; '123123',
'country' =&gt; 'US',
'address' =&gt; '1419 Westwood Blvd',
),
"notes" =&gt; "Nothing special to say",
"company" =&gt; "Example, Inc",
"emails" =&gt; array (
0 =&gt; 'mark@example.org',
1 =&gt; 'admin@example.org',
),
"emails_add" =&gt; array (
0 =&gt; 'mark.new1@example.org',
1 =&gt; 'mark.new2@example.org',
),
"phones" =&gt; array (
0 =&gt;
array(
'value' =&gt; '777-777-777',
'type' =&gt; 'home',
),
),
"socialProfiles" =&gt; array (
0 =&gt;
array(
'value' =&gt; '@markexample',
'type' =&gt; 'twitter',
),
),
"websites" =&gt; array (
0 =&gt;
array(
'value' =&gt; 'https://example.org',
),
),
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (204):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 204 No Content</code></pre>
<h3>HTTP Request</h3>
<p><code>PUT api/customers/{customerId}</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>firstName</td>
<td>string</td>
<td></td>
<td>First name of the customer (max 40 characters).</td>
</tr>
<tr>
<td>lastName</td>
<td>string</td>
<td></td>
<td>Last name of the customer (max 40 characters).</td>
</tr>
<tr>
<td>phone</td>
<td>string</td>
<td></td>
<td>Phone number.</td>
</tr>
<tr>
<td>photoUrl</td>
<td>string</td>
<td></td>
<td>URL of the customer’s photo (max 200 characters).</td>
</tr>
<tr>
<td>jobTitle</td>
<td>string</td>
<td></td>
<td>Job title (max 60 characters).</td>
</tr>
<tr>
<td>photoType</td>
<td>string</td>
<td></td>
<td>Type of photo: unknown, gravatar, twitter, facebook, googleprofile, googleplus, linkedin.</td>
</tr>
<tr>
<td>address</td>
<td>object</td>
<td></td>
<td>Customer's address (country contains <a href="https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes" target="_blank" rel="nofollow">two-letter country code</a>): { &quot;city&quot;: &quot;Los Angeles&quot;, &quot;state&quot;: &quot;California&quot;, &quot;zip&quot;: &quot;123123&quot;, &quot;country&quot;: &quot;US&quot;, &quot;address&quot;: &quot;1419 Westwood Blvd&quot; }.</td>
</tr>
<tr>
<td>notes</td>
<td>string</td>
<td></td>
<td>Notes.</td>
</tr>
<tr>
<td>company</td>
<td>string</td>
<td></td>
<td>Company (max 60 characters).</td>
</tr>
<tr>
<td>emails</td>
<td>object</td>
<td></td>
<td>List of emails (when this parameter is set the 'emails_add' parameter has no effect): [ &quot;mark@example.org&quot;, &quot;admin@example.org&quot; ].</td>
</tr>
<tr>
<td>emails_add</td>
<td>object</td>
<td></td>
<td>Add emails to the customer: [ &quot;mark.new1@example.org&quot;, &quot;mark.new2@example.org&quot; ].</td>
</tr>
<tr>
<td>phones</td>
<td>object</td>
<td></td>
<td>List of phones entries: [ { &quot;value&quot;: &quot;777-777-777&quot;, &quot;type&quot;: &quot;home&quot; } ].</td>
</tr>
<tr>
<td>socialProfiles</td>
<td>object</td>
<td></td>
<td>List of social profile entries: [ { &quot;value&quot;: &quot;@markexample&quot;, &quot;type&quot;: &quot;twitter&quot; } ].</td>
</tr>
<tr>
<td>websites</td>
<td>object</td>
<td></td>
<td>List of website entries: [ { &quot;value&quot;: &quot;https:\/\/example.org&quot; } ].</td>
</tr>
</tbody>
</table>
<!-- END_cc9faa85d22f6ac8472d46eebdabafe6 -->
<!-- START_5751a8eff0a093ec8e17624f96494d8c -->
<h2>Update Customer Fields</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/customers/1/customer_fields");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"customerFields": [
{
"id": 37,
"value": "Test value"
}
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X PUT "https://demo.freescout.net/api/customers/1/customer_fields" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"customerFields":[{"id":37,"value":"Test value"}]}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;put("https://demo.freescout.net/api/customers/1/customer_fields", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"customerFields" =&gt; array (
0 =&gt;
array(
'id' =&gt; 37,
'value' =&gt; 'Test value',
),
),
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (204):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 204 No Content</code></pre>
<h3>HTTP Request</h3>
<p><code>PUT api/customers/{customerId}/customer_fields</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>customerFields</td>
<td>array</td>
<td>(required)</td>
<td>List of customer fields to be updated.</td>
</tr>
</tbody>
</table>
<!-- END_5751a8eff0a093ec8e17624f96494d8c -->
<h1>Mailboxes</h1>
<!-- START_f6d887f2268494913dd607a56d24b613 -->
<h2>List Mailboxes</h2>
<p>Method returns mailboxes sorted by id. Request parameters can be used to filter mailboxes.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/mailboxes");
let params = {
"userId": "7",
"page": "1",
"pageSize": "100",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/mailboxes?userId=7&amp;page=1&amp;pageSize=100" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/mailboxes", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"userId" =&gt; "7",
"page" =&gt; "1",
"pageSize" =&gt; "100",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">{
"_embedded": {
"mailboxes": [
{
"id": 1,
"name": "Demo Mailbox",
"email": "support@support.example.org",
"createdAt": "2020-08-09T10-09-00Z",
"updatedAt": "2021-01-16T12-38-46Z"
}
]
},
"page": {
"size": 50,
"totalElements": 1,
"totalPages": 1,
"number": 1
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/mailboxes</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>userId</td>
<td></td>
<td>Get maiboxes to which specified user has an access.</td>
</tr>
<tr>
<td>page</td>
<td></td>
<td>Page number.</td>
</tr>
<tr>
<td>pageSize</td>
<td></td>
<td>Page size (defaults to 50).</td>
</tr>
</tbody>
</table>
<!-- END_f6d887f2268494913dd607a56d24b613 -->
<!-- START_71bf01927d52f8824bfdaa37b0fdcd25 -->
<h2>List Mailbox Custom Fields</h2>
<h4>Response Fields</h4>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>number</td>
<td>Custom field ID.</td>
</tr>
<tr>
<td>name</td>
<td>string</td>
<td>Name of the custom field.</td>
</tr>
<tr>
<td>type</td>
<td>string</td>
<td>Type of the custom field: singleline, multiline, dropdown, date, number</td>
</tr>
<tr>
<td>options</td>
<td>object</td>
<td>Contains options for dropdown custom fields.</td>
</tr>
<tr>
<td>required</td>
<td>boolean</td>
<td>Specifies if the custom field has to be filled.</td>
</tr>
<tr>
<td>sortOrder</td>
<td>number</td>
<td>Order of the custom field when displayed in the app.</td>
</tr>
</tbody>
</table>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/mailboxes/1/custom_fields");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/mailboxes/1/custom_fields" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/mailboxes/1/custom_fields", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (200):</p>
</blockquote>
<pre><code class="language-json">{
"_embedded": {
"custom_fields": [
{
"id": 18,
"name": "Priority",
"type": "dropdown",
"options": {
"1": "Low",
"2": "Medium",
"3": "High"
},
"required": false,
"sortOrder": 1
},
{
"id": 19,
"name": "Purchase Date",
"type": "date",
"options": null,
"required": false,
"sortOrder": 3
},
{
"id": 37,
"name": "Vendor",
"type": "singleline",
"options": "",
"required": false,
"sortOrder": 6
},
{
"id": 38,
"name": "Comments",
"type": "multiline",
"options": "",
"required": false,
"sortOrder": 7
},
{
"id": 39,
"name": "Amount",
"type": "number",
"options": "",
"required": false,
"sortOrder": 8
}
]
},
"page": {
"size": 50,
"totalElements": 5,
"totalPages": 1,
"number": 1
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/mailboxes/{mailboxId}/custom_fields</code></p>
<!-- END_71bf01927d52f8824bfdaa37b0fdcd25 -->
<!-- START_475f9126fcd69e6d0993f7ef95d50559 -->
<h2>List Mailbox Folders</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/mailboxes/1/folders");
let params = {
"userId": "7",
"folderId": "3",
"pageSize": "100",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/mailboxes/1/folders?userId=7&amp;folderId=3&amp;pageSize=100" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/mailboxes/1/folders", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"userId" =&gt; "7",
"folderId" =&gt; "3",
"pageSize" =&gt; "100",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (200):</p>
</blockquote>
<pre><code class="language-json">{
"_embedded": {
"folders": [
{
"id": 1681,
"name": "Unassigned",
"type": 1,
"userId": null,
"totalCount": 0,
"activeCount": 0,
"meta": null
},
{
"id": 1958,
"name": "Mine",
"type": 20,
"userId": 145,
"totalCount": 0,
"activeCount": 0,
"meta": null
},
{
"id": 1959,
"name": "Starred",
"type": 25,
"userId": 145,
"totalCount": 0,
"activeCount": 0,
"meta": null
},
{
"id": 1682,
"name": "Drafts",
"type": 30,
"userId": null,
"totalCount": 0,
"activeCount": 0,
"meta": null
},
{
"id": 1683,
"name": "Assigned",
"type": 40,
"userId": null,
"totalCount": 0,
"activeCount": 0,
"meta": null
},
{
"id": 1684,
"name": "Closed",
"type": 60,
"userId": null,
"totalCount": 0,
"activeCount": 0,
"meta": null
},
{
"id": 1685,
"name": "Spam",
"type": 80,
"userId": null,
"totalCount": 0,
"activeCount": 0,
"meta": null
},
{
"id": 1686,
"name": "Deleted",
"type": 110,
"userId": null,
"totalCount": 0,
"activeCount": 0,
"meta": null
}
]
},
"page": {
"size": 50,
"totalElements": 24,
"totalPages": 1,
"number": 1
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/mailboxes/{mailboxId}/folders</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>userId</td>
<td></td>
<td>Get folders belonging to the specified user.</td>
</tr>
<tr>
<td>folderId</td>
<td></td>
<td>Get specific folder.</td>
</tr>
<tr>
<td>pageSize</td>
<td></td>
<td>Page size (defaults to 50).</td>
</tr>
</tbody>
</table>
<!-- END_475f9126fcd69e6d0993f7ef95d50559 -->
<h1>Tags</h1>
<!-- START_dde6989ab5551d4fb09439f7cb2554c5 -->
<h2>List Tags</h2>
<p>Method returns tags sorted by id.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/tags");
let params = {
"conversationId": "7",
"page": "1",
"pageSize": "100",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/tags?conversationId=7&amp;page=1&amp;pageSize=100" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/tags", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"conversationId" =&gt; "7",
"page" =&gt; "1",
"pageSize" =&gt; "100",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">{
"_embedded": {
"tags": [
{
"id": 1,
"name": "overdue",
"counter": 5,
"color": 1
}
]
},
"page": {
"size": 50,
"totalElements": 1,
"totalPages": 1,
"number": 1
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/tags</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>conversationId</td>
<td></td>
<td>Conversation ID.</td>
</tr>
<tr>
<td>page</td>
<td></td>
<td>Page number.</td>
</tr>
<tr>
<td>pageSize</td>
<td></td>
<td>Page size (defaults to 50).</td>
</tr>
</tbody>
</table>
<!-- END_dde6989ab5551d4fb09439f7cb2554c5 -->
<!-- START_794a859956f6c8a5ea83a64d7e2a85aa -->
<h2>Update Conversation Tags</h2>
<p>This method allows to update tags for a conversation. The full list of tags must be sent in the request. If some tag specified does not exist it will be first created and then applied to the conversation. Any conversation tags which are not listed in the request will be removed. Send an empty list of tags to remove all tags.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations/1/tags");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"tags": [
"overdue",
"refund"
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X PUT "https://demo.freescout.net/api/conversations/1/tags" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"tags":["overdue","refund"]}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;put("https://demo.freescout.net/api/conversations/1/tags", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"tags" =&gt; array (
0 =&gt; 'overdue',
1 =&gt; 'refund',
),
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (204):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 204 No Content</code></pre>
<h3>HTTP Request</h3>
<p><code>PUT api/conversations/{conversationId}/tags</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>tags</td>
<td>array</td>
<td>(required)</td>
<td>List of tags (tag names) to be applied to the conversation.</td>
</tr>
</tbody>
</table>
<!-- END_794a859956f6c8a5ea83a64d7e2a85aa -->
<h1>Threads</h1>
<!-- START_2c8f7daedab7955b7ef939aaacd9da94 -->
<h2>Create Thread</h2>
<p>This method adds a new customer reply, user reply or user note to a conversation.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations/1/threads");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"type": "message",
"text": "Plese let us know if you have any other questions.",
"customer": {
"email": "mark@example.org"
},
"user": 33,
"imported": false,
"status": "closed",
"state": "published",
"cc": [
"anna@example.org",
"bill@example.org"
],
"bcc": [
"bob@example.org",
"andrea@example.org"
],
"createdAt": "2020-03-16T14:07:23Z",
"attachments": [
{
"fileName": "file.txt",
"mimeType": "plain\/text",
"data": "ZmlsZQ=="
},
{
"fileName": "file2.txt",
"mimeType": "plain\/text",
"fileUrl": "https:\/\/example.org\/uploads\/file2.txt"
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X POST "https://demo.freescout.net/api/conversations/1/threads" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"type":"message","text":"Plese let us know if you have any other questions.","customer":{"email":"mark@example.org"},"user":33,"imported":false,"status":"closed","state":"published","cc":["anna@example.org","bill@example.org"],"bcc":["bob@example.org","andrea@example.org"],"createdAt":"2020-03-16T14:07:23Z","attachments":[{"fileName":"file.txt","mimeType":"plain\/text","data":"ZmlsZQ=="},{"fileName":"file2.txt","mimeType":"plain\/text","fileUrl":"https:\/\/example.org\/uploads\/file2.txt"}]}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;post("https://demo.freescout.net/api/conversations/1/threads", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"type" =&gt; "message",
"text" =&gt; "Plese let us know if you have any other questions.",
"customer" =&gt; array(
'email' =&gt; 'mark@example.org',
),
"user" =&gt; "33",
"imported" =&gt; "",
"status" =&gt; "closed",
"state" =&gt; "published",
"cc" =&gt; array (
0 =&gt; 'anna@example.org',
1 =&gt; 'bill@example.org',
),
"bcc" =&gt; array (
0 =&gt; 'bob@example.org',
1 =&gt; 'andrea@example.org',
),
"createdAt" =&gt; "2020-03-16T14:07:23Z",
"attachments" =&gt; array (
0 =&gt;
array(
'fileName' =&gt; 'file.txt',
'mimeType' =&gt; 'plain/text',
'data' =&gt; 'ZmlsZQ==',
),
1 =&gt;
array(
'fileName' =&gt; 'file2.txt',
'mimeType' =&gt; 'plain/text',
'fileUrl' =&gt; 'https://example.org/uploads/file2.txt',
),
),
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 201 Created
Resource-ID: 25</code></pre>
<h3>HTTP Request</h3>
<p><code>POST api/conversations/{conversationId}/threads</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>string</td>
<td>(required)</td>
<td>Thread type: customer (customer reply), message (user reply), note (user note).</td>
</tr>
<tr>
<td>text</td>
<td>string</td>
<td>(required)</td>
<td>The message text.</td>
</tr>
<tr>
<td>customer</td>
<td>object</td>
<td></td>
<td>Customer adding the thread (required if thread 'type' is 'customer'). Customer object must contain a valid customer id or an email address: { &quot;id&quot;: 123 } or { &quot;email&quot;: &quot;mark@example.org&quot; }. If the id field is defined, the email will be ignored. If the id is not defined, email is used to look up a customer. If a customer does not exist, a new one will be created. If a customer is matched either via id or email field, the rest of the optional fields is ignored.</td>
</tr>
<tr>
<td>user</td>
<td>number</td>
<td></td>
<td>ID of the user who is adding the thread (required if thread 'type' is 'message' or 'note').</td>
</tr>
<tr>
<td>imported</td>
<td>boolean</td>
<td></td>
<td>When imported is set to 'true', no outgoing emails or notifications will be generated.</td>
</tr>
<tr>
<td>status</td>
<td>string</td>
<td></td>
<td>Conversation status: active, pending, closed. Use this field to change conversation status when adding a thread. If not explicitly set, a customer reply will reactivate the conversation and support agent reply will make it pending.</td>
</tr>
<tr>
<td>state</td>
<td>string</td>
<td></td>
<td>Thread state: draft, published (default).</td>
</tr>
<tr>
<td>cc</td>
<td>array</td>
<td></td>
<td>List of CC email addresses.</td>
</tr>
<tr>
<td>bcc</td>
<td>array</td>
<td></td>
<td>List of BCC email addresses.</td>
</tr>
<tr>
<td>createdAt</td>
<td>string</td>
<td></td>
<td>Creation date to be used when importing conversations and threads in ISO 8601 date time format (can be used only when 'imported' field is set to true).</td>
</tr>
<tr>
<td>attachments</td>
<td>array</td>
<td></td>
<td>List of attachments to be attached to the thread. Attachment content can be passed in &quot;data&quot; parameter as BASE64 encoded string or as URL in &quot;fileUrl&quot; parameter.</td>
</tr>
</tbody>
</table>
<!-- END_2c8f7daedab7955b7ef939aaacd9da94 -->
<h1>Timelogs</h1>
<!-- START_abf1c40fcabb2bc92586516518f6ed42 -->
<h2>List Conversation Timelogs</h2>
<p>Get Time Tracking Module timelogs for a conversation. Timelogs are sorted from newest to oldest.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/conversations/1/timelogs");
let params = {
"page": "1",
"pageSize": "100",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/conversations/1/timelogs?page=1&amp;pageSize=100" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/conversations/1/timelogs", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"page" =&gt; "1",
"pageSize" =&gt; "100",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">{
"_embedded": {
"timelogs": [
{
"id": 498,
"conversationStatus": "pending",
"userId": 1,
"timeSpent": 219,
"paused": false,
"finished": true,
"createdAt": "2021-04-21T13-24-01Z",
"updatedAt": "2021-04-21T13-43-10Z"
},
{
"id": 497,
"conversationStatus": "active",
"userId": 1,
"timeSpent": 711,
"paused": false,
"finished": true,
"createdAt": "2021-04-21T13-22-09Z",
"updatedAt": "2021-04-21T13-43-10Z"
}
]
},
"page": {
"size": 50,
"totalElements": 1,
"totalPages": 1,
"number": 1
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/conversations/{conversationId}/timelogs</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>page</td>
<td></td>
<td>Page number.</td>
</tr>
<tr>
<td>pageSize</td>
<td></td>
<td>Page size (defaults to 50).</td>
</tr>
</tbody>
</table>
<!-- END_abf1c40fcabb2bc92586516518f6ed42 -->
<h1>Users</h1>
<!-- START_12e37982cc5398c7100e59625ebb5514 -->
<h2>Create User</h2>
<p>This method does not update existing users. Method makes sure that the email address is unique and does not check uniqueness of other parameters. Method creates only regular Users and does not allow to create Administrators. No invitation email is being sent upon user creation. Created user does not have permissions to access any mailboxes by default.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/users");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@example.org",
"password": "123456789",
"alternateEmails": "johndoe777@example.org",
"jobTitle": "Support agent",
"phone": "777-777-777",
"timezone": "Europe\/Paris",
"photoUrl": "https:\/\/example.org\/upload\/customer.jpg"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X POST "https://demo.freescout.net/api/users" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"firstName":"John","lastName":"Doe","email":"johndoe@example.org","password":"123456789","alternateEmails":"johndoe777@example.org","jobTitle":"Support agent","phone":"777-777-777","timezone":"Europe\/Paris","photoUrl":"https:\/\/example.org\/upload\/customer.jpg"}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;post("https://demo.freescout.net/api/users", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"firstName" =&gt; "John",
"lastName" =&gt; "Doe",
"email" =&gt; "johndoe@example.org",
"password" =&gt; "123456789",
"alternateEmails" =&gt; "johndoe777@example.org",
"jobTitle" =&gt; "Support agent",
"phone" =&gt; "777-777-777",
"timezone" =&gt; "Europe/Paris",
"photoUrl" =&gt; "https://example.org/upload/customer.jpg",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 201 Created
Resource-ID: 17</code></pre>
<h3>HTTP Request</h3>
<p><code>POST api/users</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>firstName</td>
<td>string</td>
<td>(required)</td>
<td>First name of the user.</td>
</tr>
<tr>
<td>lastName</td>
<td>string</td>
<td>(required)</td>
<td>Last name of the user.</td>
</tr>
<tr>
<td>email</td>
<td>string</td>
<td>(required)</td>
<td>Email address.</td>
</tr>
<tr>
<td>password</td>
<td>string</td>
<td></td>
<td>User password.</td>
</tr>
<tr>
<td>alternateEmails</td>
<td>string</td>
<td></td>
<td>User alternate emails (comma separated).</td>
</tr>
<tr>
<td>jobTitle</td>
<td>string</td>
<td></td>
<td>Job title.</td>
</tr>
<tr>
<td>phone</td>
<td>string</td>
<td></td>
<td>Phone number.</td>
</tr>
<tr>
<td>timezone</td>
<td>string</td>
<td></td>
<td>User timezone. List of timezones: <a href="https://www.php.net/manual/en/timezones.php">https://www.php.net/manual/en/timezones.php</a>.</td>
</tr>
<tr>
<td>photoUrl</td>
<td>string</td>
<td></td>
<td>URL of the user's photo.</td>
</tr>
</tbody>
</table>
<!-- END_12e37982cc5398c7100e59625ebb5514 -->
<!-- START_d75d1239520346b5c625a2a483b653dc -->
<h2>Get User</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/users/1");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/users/1" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/users/1", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (200):</p>
</blockquote>
<pre><code class="language-json">{
"id": 1,
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@example.org",
"role": "admin",
"alternateEmails": "johndoe777@example.org",
"jobTitle": "Support agent",
"phone": "+1867342345",
"timezone": "Etc\/GMT-3",
"photoUrl": "https:\/\/example.org\/upload\/customer.jpg",
"language": "en",
"createdAt": "2018-08-09T10-08-53Z",
"updatedAt": "2020-12-22T14-54-35Z"
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/users/{userId}</code></p>
<!-- END_d75d1239520346b5c625a2a483b653dc -->
<!-- START_fc1e4f6a697e3c48257de845299b71d5 -->
<h2>List Users</h2>
<p>Request parameters can be used to filter users.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/users");
let params = {
"email": "johndoe@example.org",
"page": "1",
"pageSize": "100",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "GET",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X GET -G "https://demo.freescout.net/api/users?email=johndoe%40example.org&amp;page=1&amp;pageSize=100" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;get("https://demo.freescout.net/api/users", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"email" =&gt; "johndoe@example.org",
"page" =&gt; "1",
"pageSize" =&gt; "100",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">{
"_embedded": {
"users": [
{
"id": 1,
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@example.org",
"role": "admin",
"alternateEmails": "johndoe777@example.org",
"jobTitle": "Support agent",
"phone": "+1867342345",
"timezone": "Etc\/GMT-3",
"photoUrl": "https:\/\/example.org\/upload\/customer.jpg",
"language": "en",
"createdAt": "2018-08-09T10-08-53Z",
"updatedAt": "2020-12-22T14-54-35Z"
}
]
},
"page": {
"size": 50,
"totalElements": 1,
"totalPages": 1,
"number": 1
}
}</code></pre>
<h3>HTTP Request</h3>
<p><code>GET api/users</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>email</td>
<td></td>
<td>Look up user by email.</td>
</tr>
<tr>
<td>page</td>
<td></td>
<td>Page number.</td>
</tr>
<tr>
<td>pageSize</td>
<td></td>
<td>Page size (defaults to 50).</td>
</tr>
</tbody>
</table>
<!-- END_fc1e4f6a697e3c48257de845299b71d5 -->
<!-- START_a812ad7216b5b2d96aef13e7b49604f7 -->
<h2>Delete User</h2>
<p>This method deletes a user.</p>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/users/1");
let params = {
"byUserId": "1",
"assignTo": "assignTo[2]=7",
};
Object.keys(params).forEach(key =&gt; url.searchParams.append(key, params[key]));
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X DELETE "https://demo.freescout.net/api/users/1?byUserId=1&amp;assignTo=assignTo%5B2%5D%3D7" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;delete("https://demo.freescout.net/api/users/1", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
'query' =&gt; [
"byUserId" =&gt; "1",
"assignTo" =&gt; "assignTo[2]=7",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (204):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 204 No Content</code></pre>
<h3>HTTP Request</h3>
<p><code>DELETE api/users/{userId}</code></p>
<h4>Query Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>byUserId</td>
<td>(required)</td>
<td>ID of the user performing the deletion of the user.</td>
</tr>
<tr>
<td>assignTo</td>
<td></td>
<td>Optional mapping array determining new assignee for conversations assigned to the user which is being deleted. Format: assignTo[MAILBOX_ID]=NEW_ASSIGNEE_ID.</td>
</tr>
</tbody>
</table>
<!-- END_a812ad7216b5b2d96aef13e7b49604f7 -->
<h1>Webhooks</h1>
<!-- START_bc21adbacd4d04a672f21b2db9813c44 -->
<h2>Create Webhook</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/webhooks");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Content-Type": "application/json",
"Accept": "application/json",
}
let body = {
"url": "https:\/\/example.org\/freescout",
"events": [
"convo.created"
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X POST "https://demo.freescout.net/api/webhooks" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db" \
-H "Content-Type: application/json" \
-d '{"url":"https:\/\/example.org\/freescout","events":["convo.created"]}'
</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;post("https://demo.freescout.net/api/webhooks", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
"Content-Type" =&gt; "application/json",
],
'json' =&gt; [
"url" =&gt; "https://example.org/freescout",
"events" =&gt; array (
0 =&gt; 'convo.created',
),
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (201):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 201 Created
Resource-ID: 17</code></pre>
<h3>HTTP Request</h3>
<p><code>POST api/webhooks</code></p>
<h4>Body Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>url</td>
<td>string</td>
<td>(required)</td>
<td>URL that will be called when any of the events occur.</td>
</tr>
<tr>
<td>events</td>
<td>array</td>
<td>(required)</td>
<td>List of events to track: convo.assigned, convo.created, convo.deleted, convo.moved, convo.status, convo.customer.reply.created, convo.agent.reply.created, convo.note.created, customer.created, customer.updated.</td>
</tr>
</tbody>
</table>
<!-- END_bc21adbacd4d04a672f21b2db9813c44 -->
<!-- START_051884c3f3f0766eb3c7cd7b49434380 -->
<h2>Delete Webhook</h2>
<blockquote>
<p>Example request:</p>
</blockquote>
<pre><code class="language-javascript">const url = new URL("https://demo.freescout.net/api/webhooks/1");
let headers = {
"X-FreeScout-API-Key": "c2ba609c687a3425402b9d881e5075db",
"Accept": "application/json",
"Content-Type": "application/json; charset=UTF-8",
}
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response =&gt; response.json())
.then(json =&gt; console.log(json));</code></pre>
<pre><code class="language-bash">curl -X DELETE "https://demo.freescout.net/api/webhooks/1" \
-H "X-FreeScout-API-Key: c2ba609c687a3425402b9d881e5075db"</code></pre>
<pre><code class="language-php">
$client = new \GuzzleHttp\Client();
$response = $client-&gt;delete("https://demo.freescout.net/api/webhooks/1", [
'headers' =&gt; [
"X-FreeScout-API-Key" =&gt; "c2ba609c687a3425402b9d881e5075db",
],
]);
$body = $response-&gt;getBody();
print_r(json_decode((string) $body));</code></pre>
<blockquote>
<p>Example response (204):</p>
</blockquote>
<pre><code class="language-json">HTTP/1.1 204 No Content</code></pre>
<h3>HTTP Request</h3>
<p><code>DELETE api/webhooks/{webhookId}</code></p>
<!-- END_051884c3f3f0766eb3c7cd7b49434380 -->
</div>
<div class="dark-box">
<div class="lang-selector">
<a href="#" data-language-name="javascript">javascript</a>
<a href="#" data-language-name="bash">bash</a>
<a href="#" data-language-name="php">php</a>
</div>
</div>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink