Skip to content

Commit 7739bb5

Browse files
committed
JETS-382: Add custom data bad request case
1 parent 76dd739 commit 7739bb5

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

source/api_documentation/signal_api/index.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ For example, if a **transaction_id** or **call_start_time** are not passed in th
235235
236236
If there are multiple issues with the request, we will do our best to package all of the issues together in one response message.
237237

238-
**Example Bad Request**
238+
**Example Bad Signal Request**
239239

240240
.. code-block:: json
241241
@@ -279,6 +279,31 @@ If there are multiple issues with the request, we will do our best to package al
279279
}
280280
}
281281
282+
**Example Bad Custom Data Request**
283+
284+
.. code-block:: json
285+
286+
{
287+
"search": {
288+
"transaction_id": "0000000-0000000A"
289+
},
290+
"custom_data": {
291+
"agent": "James Bond"
292+
},
293+
"oauth_token": "<YOUR OAUTH TOKEN>"
294+
}
295+
296+
**Response (403 Forbidden):**
297+
298+
.. code-block:: json
299+
300+
{
301+
"errors": {
302+
"class": "InvalidInput",
303+
"invalid_data": "'custom_data' must be an array of hashes"
304+
}
305+
}
306+
282307
-----
283308

284309
**Record Invalid Error**

0 commit comments

Comments
 (0)