Developer docs
/
Rebilly API
/
Custom fields
/
Create or alter a custom field

Create or alter a custom field

Creates or alters a specified custom field schema for a specified resource.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
resource
required
string

Type of resource schema.

Enum: "customers" "payment-instruments" "subscriptions" "transactions" "websites" "products" "plans" "bump-offers" "gateway-accounts" "deposit-requests"
name
required
string <= 60 characters ^[\w-]+$

ID of the custom field.

Request Body schema: application/json
required

Custom fields schema of the specified resource.

type
required
string

Describes the data type. Custom field type value cannot be changed.

Array of strings with up to 255 characters. Maximum size is 1000 elements.

description
string or null

Description of the custom field.

object or null

Additional schema which adds additional values constrains.

put
/custom-fields/{resource}/{name}
Request samples
application/json
{
"type": "array",
"description": "string",
"additionalSchema": {

"required": true,

}
}
Responses

200

Custom field updated.

Response Schema: application/json
name
string

Name of the custom field.

type
required
string

Describes the data type. Custom field type value cannot be changed.

Array of strings with up to 255 characters. Maximum size is 1000 elements.

description
string or null

Description of the custom field.

object or null

Additional schema which adds additional values constrains.

Array of objects (SelfLink)

Related links.

201

Custom field created.

401

Unauthorized access. Invalid credentials used.

409

Schema in use. To remove or alter the schema, remove all associated data.

422

Invalid data sent.

Response samples
application/json
{
"name": "string",
"type": "array",
"description": "string",
"additionalSchema": {

"required": true,

},
"_links": [

]
}