Skip to main content
POST
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
bulk_category_feedback
Bulk create category feedback for an end user
curl --request POST \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/bulk_category_feedback \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "category": {
    "heron_id": "ctg_ioQk7KRmz5ejKoY6YPCkyJ",
    "label": "Insurance"
  },
  "source": null,
  "transaction_heron_ids": [],
  "transaction_reference_ids": []
}
'
{
  "num_annotations": 1
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_id_or_heron_id
string
required

Query Parameters

​
high_priority
boolean
default:false

Whether to process the feedback with high priority

Body

application/json

A list of objects containing a Transaction's heron id and the suggested Category. If you provide a heron_id for Category, you don't need to provide other fields. If heron_id is provided, we disregard label.

​
category
object
required
​
source
string | null

your identifier for where the feedback comes from e.g. bob_the_underwriter

Maximum string length: 120
​
transaction_heron_ids
string[]

List of transaction heron IDs

​
transaction_reference_ids
string[]

List of transaction reference IDs

Response

201 - application/json

OK

​
num_annotations
integer

The number of category annotations added

Example:

1