API reference

Create custom field

post
https://sandbox.numeral.io/v1/custom_fields

Create a custom field to categorize your objects in Numeral.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The key of the custom field. Must be unique and snake_case.

string
required

The name of the custom field, which is an understandable description of the data it holds.

string
enum
required

The type of the custom field. Can be either select or text.

Allowed:
object_types
array of strings
required

The types of object this custom field can be applied to. Can be a combination of payment_order, expected_payment, transaction, direct_debit_mandate, internal_account and external_account.

object_types*
values
array of objects

List of values the custom field can take. Only applicable to custom fields with select type.

values
Responses

Updated about 23 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 23 hours ago