Create a Custom Field

POST 
/v2/settings/extensions/custom-apis/:custom_api_id/fields

Create a Custom Field

Request

Path Parameters

custom_api_id stringrequired
The id of the Custom API.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

application/json

Body

data object required

anyOf

BooleanCustomFieldAttributes

type string

Specifies the type of the resource object, use custom_field for Custom Field.

name string

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom Field.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug string

Possible values: non-empty and <= 63 characters

Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

field_type string

Possible values: [string, integer, boolean, float]

Specifies the type of the field. This field cannot be updated.

use_as_url_slug boolean

Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).

presentation object

sort_order integer

Possible values: <= 1000

Default value: 0

Specifies the order of the field in the User Interface.

validation object

boolean object

allow_null_values booleannull

Default value: true

When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.

immutable booleannull

When set to true, prevents changing the field.

StringCustomFieldAttributes

type string

Specifies the type of the resource object, use custom_field for Custom Field.

name string

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom Field.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug string

Possible values: non-empty and <= 63 characters

Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

field_type string

Possible values: [string, integer, boolean, float]

Specifies the type of the field. This field cannot be updated.

use_as_url_slug boolean

Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).

presentation object

sort_order integer

Possible values: <= 1000

Default value: 0

Specifies the order of the field in the User Interface.

validation object

string object

min_length integernull

Possible values: <= 65535

Specifies the minimum number of characters that can be stored.

max_length integernull

Possible values: <= 65535

Specifies the minimum number of characters that can be stored.

regex stringnull

Possible values: <= 1024 characters

An RE2 regular expression that used to restrict the specific characters that can be stored.

allow_null_values boolean

Default value: true

When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted. nullable: false

unique string

Possible values: [yes, no]

Default value: no

If yes, this prevents two Custom API entries from having the same value for this field within the Custom API. When set to no (the default), multiple Custom API entries may have the same value

unique_case_insensitivity boolean

Controls case-insensitive uniqueness for this field. Can only be set to true if unique is set to yes. If true, prevents two Custom API entries from having the same value for this field within the Custom API, ignoring case differences. When set to false (the default), case is considered when checking for uniqueness. This value can only be set during field creation and cannot be modified afterwards.

immutable boolean

When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests.

IntegerCustomFieldAttributes

type string

Specifies the type of the resource object, use custom_field for Custom Field.

name string

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom Field.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug string

Possible values: non-empty and <= 63 characters

Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

field_type string

Possible values: [string, integer, boolean, float]

Specifies the type of the field. This field cannot be updated.

use_as_url_slug boolean

Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).

presentation object

sort_order integer

Possible values: <= 1000

Default value: 0

Specifies the order of the field in the User Interface.

validation object

integer object

min_value integernull

Specifies the minimum whole number that can be stored.

max_value integernull

Specifies the maximum whole number that can be stored.

allow_null_values booleannull

Default value: true

When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.

immutable booleannull

When set to true, prevents changing the field.

FloatCustomFieldAttributes

type string

Specifies the type of the resource object, use custom_field for Custom Field.

name string

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom Field.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug string

Possible values: non-empty and <= 63 characters

Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

field_type string

Possible values: [string, integer, boolean, float]

Specifies the type of the field. This field cannot be updated.

use_as_url_slug boolean

Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).

presentation object

sort_order integer

Possible values: <= 1000

Default value: 0

Specifies the order of the field in the User Interface.

validation object

float object

min_value integernull

Specifies the minimum whole number that can be stored.

max_value integernull

Specifies the maximum whole number that can be stored.

allow_null_values booleannull

Default value: true

When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.

immutable booleannull

When set to true, prevents changing the field.

Responses

201

Created

application/json

Schema

Schema

data object required

anyOf

BooleanCustomFieldAttributes

id uuid

The unique identifier of the Custom Field.

type string

Specifies the type of the resource object, use custom_field for Custom Field.

name string

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom Field.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug string

Possible values: non-empty and <= 63 characters

Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

field_type string

Possible values: [string, integer, boolean, float]

Specifies the type of the field. This field cannot be updated.

use_as_url_slug boolean

Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).

presentation object

sort_order integer

Possible values: <= 1000

Default value: 0

Specifies the order of the field in the User Interface.

links object

self uri

meta object

timestamps objectrequired

updated_at stringrequired

Specifies the date the entity is created.

created_at stringrequired

Specifies the date the entity is last updated.

validation object

boolean object

allow_null_values booleannull

Default value: true

When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.

immutable booleannull

When set to true, prevents changing the field.

StringCustomFieldAttributes

id uuid

The unique identifier of the Custom Field.

type string

Specifies the type of the resource object, use custom_field for Custom Field.

name string

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom Field.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug string

Possible values: non-empty and <= 63 characters

Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

field_type string

Possible values: [string, integer, boolean, float]

Specifies the type of the field. This field cannot be updated.

use_as_url_slug boolean

Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).

presentation object

sort_order integer

Possible values: <= 1000

Default value: 0

Specifies the order of the field in the User Interface.

links object

self uri

meta object

timestamps objectrequired

updated_at stringrequired

Specifies the date the entity is created.

created_at stringrequired

Specifies the date the entity is last updated.

validation object

string object

min_length integernull

Possible values: <= 65535

Specifies the minimum number of characters that can be stored.

max_length integernull

Possible values: <= 65535

Specifies the minimum number of characters that can be stored.

regex stringnull

Possible values: <= 1024 characters

An RE2 regular expression that used to restrict the specific characters that can be stored.

allow_null_values boolean

Default value: true

When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted. nullable: false

unique string

Possible values: [yes, no]

Default value: no

If yes, this prevents two Custom API entries from having the same value for this field within the Custom API. When set to no (the default), multiple Custom API entries may have the same value

unique_case_insensitivity boolean

Controls case-insensitive uniqueness for this field. Can only be set to true if unique is set to yes. If true, prevents two Custom API entries from having the same value for this field within the Custom API, ignoring case differences. When set to false (the default), case is considered when checking for uniqueness. This value can only be set during field creation and cannot be modified afterwards.

immutable boolean

When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests.

IntegerCustomFieldAttributes

id uuid

The unique identifier of the Custom Field.

type string

Specifies the type of the resource object, use custom_field for Custom Field.

name string

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom Field.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug string

Possible values: non-empty and <= 63 characters

Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

field_type string

Possible values: [string, integer, boolean, float]

Specifies the type of the field. This field cannot be updated.

use_as_url_slug boolean

Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).

presentation object

sort_order integer

Possible values: <= 1000

Default value: 0

Specifies the order of the field in the User Interface.

links object

self uri

meta object

timestamps objectrequired

updated_at stringrequired

Specifies the date the entity is created.

created_at stringrequired

Specifies the date the entity is last updated.

validation object

integer object

min_value integernull

Specifies the minimum whole number that can be stored.

max_value integernull

Specifies the maximum whole number that can be stored.

allow_null_values booleannull

Default value: true

When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.

immutable booleannull

When set to true, prevents changing the field.

FloatCustomFieldAttributes

id uuid

The unique identifier of the Custom Field.

type string

Specifies the type of the resource object, use custom_field for Custom Field.

name string

Possible values: non-empty and <= 255 characters

Specifies the name of this Custom Field.

description string

Possible values: <= 255 characters

Specifies the description for this Custom API.

slug string

Possible values: non-empty and <= 63 characters

Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

field_type string

Possible values: [string, integer, boolean, float]

Specifies the type of the field. This field cannot be updated.

use_as_url_slug boolean

Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).

presentation object

sort_order integer

Possible values: <= 1000

Default value: 0

Specifies the order of the field in the User Interface.

links object

self uri

meta object

timestamps objectrequired

updated_at stringrequired

Specifies the date the entity is created.

created_at stringrequired

Specifies the date the entity is last updated.

validation object

float object

min_value integernull

Specifies the minimum whole number that can be stored.

max_value integernull

Specifies the maximum whole number that can be stored.

allow_null_values booleannull

Default value: true

When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.

immutable booleannull

When set to true, prevents changing the field.

Example (from schema)

{}

string_field

String field example

{
  "data": {
    "type": "custom_field",
    "name": "Name",
    "description": "This field stores the name of the wishlist.",
    "slug": "name",
    "field_type": "string",
    "validation": {
      "string": {
        "min_length": 3,
        "max_length": 128,
        "regex": null,
        "allow_null_values": true,
        "immutable": false,
        "unique": "no",
        "unique_case_insensitivity": false
      }
    },
    "id": "859aeba1-03c2-4822-bd4c-89afce93d7eb",
    "links": {
      "self": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/859aeba1-03c2-4822-bd4c-89afce93d7eb"
    },
    "meta": {
      "timestamps": {
        "created_at": "2017-01-10T11:41:19.244Z",
        "updated_at": "2017-01-10T11:41:19.244Z"
      }
    }
  }
}

integer_field

Integer field example

{
  "data": {
    "type": "custom_field",
    "name": "Items Count",
    "description": "This field stores the total count of items in the wishlist.",
    "slug": "items_count",
    "field_type": "integer",
    "validation": {
      "integer": {
        "min_value": null,
        "max_value": null,
        "allow_null_values": true,
        "immutable": false
      }
    },
    "id": "859aeba1-03c2-4822-bd4c-89afce93d7eb",
    "links": {
      "self": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/859aeba1-03c2-4822-bd4c-89afce93d7eb"
    },
    "meta": {
      "timestamps": {
        "created_at": "2017-01-10T11:41:19.244Z",
        "updated_at": "2017-01-10T11:41:19.244Z"
      }
    }
  }
}

boolean_field

Boolean field example

{
  "data": {
    "type": "custom_field",
    "name": "Keep Purchased Items",
    "description": "This field stores whether or not to keep purchased items on the wishlist.",
    "slug": "keep_purchased",
    "field_type": "boolean",
    "validation": {
      "boolean": {
        "allow_null_values": true,
        "immutable": false
      }
    },
    "id": "859aeba1-03c2-4822-bd4c-89afce93d7eb",
    "links": {
      "self": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/859aeba1-03c2-4822-bd4c-89afce93d7eb"
    },
    "meta": {
      "timestamps": {
        "created_at": "2017-01-10T11:41:19.244Z",
        "updated_at": "2017-01-10T11:41:19.244Z"
      }
    }
  }
}

float_field

Float field example

{
  "data": {
    "type": "custom_field",
    "name": "Items Weight",
    "description": "This field stores the total weight (in kilograms) of the items in the wishlist.",
    "slug": "items_weight",
    "field_type": "float",
    "validation": {
      "float": {
        "min_value": 0,
        "max_value": null,
        "allow_null_values": true,
        "immutable": false
      }
    },
    "id": "859aeba1-03c2-4822-bd4c-89afce93d7eb",
    "links": {
      "self": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/859aeba1-03c2-4822-bd4c-89afce93d7eb"
    },
    "meta": {
      "timestamps": {
        "created_at": "2017-01-10T11:41:19.244Z",
        "updated_at": "2017-01-10T11:41:19.244Z"
      }
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

missing-name

Required field missing

{
  "errors": [
    {
      "title": "Bad Request",
      "status": "400",
      "detail": "The field 'name' is required."
    }
  ]
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

not-found

Requested entity not found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "Not found"
    }
  ]
}

409

Unable to perform the operation at this time.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

duplicate-custom-api

Duplicate Custom API

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "custom_api with the given api_type already exists"
    }
  ]
}

duplicate-custom-field

Duplicate Custom Field

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "custom_field with the given slug already exists"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...