v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EnrichmentFeedback

Bulk create category feedback for an end user

Provide bulk feedback on Transaction Categories for a specified end user

post/api/end_users/{end_user_id_or_heron_id}/bulk_category_feedback

Path parameters

end_user_id_or_heron_idstring required

Query parameters

high_priorityboolean

Whether to process the feedback with high priority

Request body

sourcestring nullable

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

transaction_heron_idsstring[]

List of transaction heron IDs

transaction_reference_idsstring[]

List of transaction reference IDs

Example request

{
  "category": {
    "heron_id": "ctg_Hyv4jvQtWZcTH8jVL5sHpt",
    "label": "Insurance"
  },
  "transaction_heron_ids": [
    "txn_8KwEXu4CYMcKLzQTAXw8JB"
  ],
  "transaction_reference_ids": [
    "your_reference_id"
  ]
}

Response

OK

num_annotationsinteger

The number of category annotations added

transaction_heron_idsstring[]

List of affected transaction heron IDs

Example response

{
  "num_annotations": 1
}