Create an account tag

post

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

Defines an account tag: a label with a type, which you can set on any account. Use it to record your own attributes, such as a risk tier. To set a tag on an account, use Set an account tag.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Account Tag creation request

name

string

required

The tag name, unique in your workspace.

description

string

What the tag means.

type

string

enum

required

The kind of value the tag holds.

Boolean: true or false.
String: free text.
DateTime: an epoch timestamp, as a string.
Number: a number.
Custom: one value from custom_values.
MultiCustom: several values from custom_values.

Allowed:

currency_code

string | null

^[A-Z]{3}$

Defaults to null

The uppercase ISO 4217 currency code, for Number tags only. Optional, and null means the tag holds no currency.

custom_values

array of strings

The allowed values. Required for Custom and MultiCustom tags.

custom_values

mode

string

enum

required

Who can change the value. Without it the request returns 500.

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

Allowed:

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 account 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.

500mode is missing, or a tag with this name already exists. Send mode. For a duplicate, read the existing tag from the list and reuse it.