Create a transaction tag

post

https://sandbox-api.coris.ai/api/v0_2/transaction_tags/

Defines a transaction tag: a label with a type, which you can set on any transaction. To set it on a transaction, use Set a transaction tag.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Transaction Tag creation request

name

string

required

length ≤ 256

The tag name, unique in your workspace.

description

string

length ≤ 256

What the tag means.

type

string

enum

required

The kind of value the tag holds.

Boolean: true or false.
String: free text.
DateTime: a date and time.
Number: a number.
Custom: one value from custom_values.

Allowed:

custom_values

array of strings

The allowed values, as a list of strings. Required for Custom tags, and rejected for every other type.

custom_values

mode

string

enum

Who can change the value. Default: ReadWrite.

ReadWrite: anyone with write access.
ReadOnly: nobody, through the API. A write returns 400.

Allowed:

ui_filter_enabled

boolean

Defaults to false

true to make this tag a filter in the portal.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

A field is missing or invalid. Read the response body, fix the field and resend.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

201The tag was created.

401The key is missing, or it is wrong for this host. Send Authorization: Token YOUR_API_KEY with a key issued for this environment.

403The key's user does not have access to manage transaction tags. Ask Coris support. A scoped key cannot use this route, and gets JSON with detail. Use a key without account limits.

429You passed a rate limit. If Retry-After is present, wait that many seconds, then retry. If it is absent, you hit the concurrency limit, so back off for a few seconds and reduce parallel calls.

500Coris failed to process the request. Retry with backoff. If it continues, contact support.