Labels

Create Label

Creates a label for the team.

POST
/api/v1/labels

Creates a label for the team. Labels are the routing primitive: assign one to a supplier and every document matched to that supplier inherits it, or assign one to a document directly. They are team-wide, so a label created here is available to every company in the team. Set externalId to the identifier your own system uses, so you can address the label without storing ours.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/labels" \  -H "Content-Type: application/json" \  -d '{    "name": "ERP",    "colorHex": "#3B82F6"  }'
{  "success": true,  "label": {    "id": "lbl_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "teamId": "string",    "externalId": "erp-routing-inbox",    "name": "ERP",    "colorHex": "#3B82F6",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

List Labels GET

Returns every label in the team, unpaginated.

Get Label GET

Returns one label.