Create or alter a custom field

Request

Creates or alters a specified custom field schema for a specified resource.
Security
SecretApiKey or JWT
Path
resourcestringrequired
Type of resource schema.
Enum:"customers""payment-instruments""orders""subscriptions""transactions""websites""products""plans""gateway-accounts""deposit-requests"
namestring, <= 60 characters^[\w-]+$required
ID of the custom field.
Bodyapplication/jsonrequired
Custom fields schema of the specified resource.
typestringrequired
Describes the data type. The custom field type value cannot be changed. Array of strings with up to 255 characters. The maximum size is 1000 elements.
Value:"array"
Discriminator
descriptionstring or null
Description of the custom field.
isEnabledboolean
Specifies if the custom field is enabled.
Default:true
additionalSchemaobject or null
Additional schema which adds additional values constrains.
curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/custom-fields/{resource}/{name}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "type": "array",
    "description": "string",
    "isEnabled": true,
    "additionalSchema": {
      "allowedValues": [
        "string"
      ],
      "required": true,
      "default": [
        "string"
      ]
    }
  }'

Responses

Custom field updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
namestringread-only
Name of the custom field.
typestringrequired
Describes the data type. The custom field type value cannot be changed. Array of strings with up to 255 characters. The maximum size is 1000 elements.
Value:"array"
Discriminator
descriptionstring or null
Description of the custom field.
isEnabledboolean
Specifies if the custom field is enabled.
Default:true
additionalSchemaobject or null
Additional schema which adds additional values constrains.
_linksArray of objects(SelfLink)read-only
Related links.
Response
{
  "name": "string",
  "type": "array",
  "description": "string",
  "isEnabled": true,
  "additionalSchema": {
    "allowedValues": [ … ],
    "required": true,
    "default": [ … ]
  },
  "_links": [
    { … }
  ]
}