Create a Custom Field

POST 
https://useast.api.elasticpath.com/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 objectrequired
field_typerequired
Possible values: [boolean, float, integer, string]
boolean
typestring
Specifies the type of the resource object, use custom_field for Custom Field.
namestring
Specifies the name of this Custom Field.
Possible values: non-empty and <= 255 characters
descriptionstring
Specifies the description for this Custom API.
Possible values: <= 255 characters
slugstring
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.
Possible values: non-empty and <= 63 characters
field_typestring
Specifies the type of the field. This field cannot be updated.
Possible values: [string, integer, boolean, float]
use_as_url_slugboolean
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_orderinteger
Specifies the order of the field in the User Interface.
Possible values: <= 1000
Default value: 0
Example: 10
validation object
boolean object
allow_null_valuesboolean | null
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.
Default value: true
immutableboolean | null
When set to true, prevents changing the field.
Default value: false
float
typestring
Specifies the type of the resource object, use custom_field for Custom Field.
namestring
Specifies the name of this Custom Field.
Possible values: non-empty and <= 255 characters
descriptionstring
Specifies the description for this Custom API.
Possible values: <= 255 characters
slugstring
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.
Possible values: non-empty and <= 63 characters
field_typestring
Specifies the type of the field. This field cannot be updated.
Possible values: [string, integer, boolean, float]
use_as_url_slugboolean
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_orderinteger
Specifies the order of the field in the User Interface.
Possible values: <= 1000
Default value: 0
Example: 10
validation object
float object
min_valueinteger | null
Specifies the minimum whole number that can be stored.
max_valueinteger | null
Specifies the maximum whole number that can be stored.
allow_null_valuesboolean | null
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.
Default value: true
immutableboolean | null
When set to true, prevents changing the field.
Default value: false
integer
typestring
Specifies the type of the resource object, use custom_field for Custom Field.
namestring
Specifies the name of this Custom Field.
Possible values: non-empty and <= 255 characters
descriptionstring
Specifies the description for this Custom API.
Possible values: <= 255 characters
slugstring
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.
Possible values: non-empty and <= 63 characters
field_typestring
Specifies the type of the field. This field cannot be updated.
Possible values: [string, integer, boolean, float]
use_as_url_slugboolean
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_orderinteger
Specifies the order of the field in the User Interface.
Possible values: <= 1000
Default value: 0
Example: 10
validation object
integer object
min_valueinteger | null
Specifies the minimum whole number that can be stored.
max_valueinteger | null
Specifies the maximum whole number that can be stored.
allow_null_valuesboolean | null
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.
Default value: true
immutableboolean | null
When set to true, prevents changing the field.
Default value: false
string
typestring
Specifies the type of the resource object, use custom_field for Custom Field.
namestring
Specifies the name of this Custom Field.
Possible values: non-empty and <= 255 characters
descriptionstring
Specifies the description for this Custom API.
Possible values: <= 255 characters
slugstring
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.
Possible values: non-empty and <= 63 characters
field_typestring
Specifies the type of the field. This field cannot be updated.
Possible values: [string, integer, boolean, float]
use_as_url_slugboolean
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_orderinteger
Specifies the order of the field in the User Interface.
Possible values: <= 1000
Default value: 0
Example: 10
validation object
string object
min_lengthinteger | null
Specifies the minimum number of characters that can be stored.
Possible values: <= 65535
Example: 1
max_lengthinteger | null
Specifies the minimum number of characters that can be stored.
Possible values: <= 65535
regexstring | null
An RE2 regular expression that used to restrict the specific characters that can be stored.
Possible values: <= 1024 characters
Example: 1
allow_null_valuesboolean
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
Default value: true
uniquestring
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
Possible values: [yes, no]
Default value: no
unique_case_insensitivityboolean
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.
Default value: false
immutableboolean
When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests.
Default value: false

Responses

201

Created

application/json

Schema

Schema

data objectrequired
field_typerequired
Possible values: [boolean, float, integer, string]
boolean
iduuid
The unique identifier of the Custom Field.
typestring
Specifies the type of the resource object, use custom_field for Custom Field.
namestring
Specifies the name of this Custom Field.
Possible values: non-empty and <= 255 characters
descriptionstring
Specifies the description for this Custom API.
Possible values: <= 255 characters
slugstring
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.
Possible values: non-empty and <= 63 characters
field_typestring
Specifies the type of the field. This field cannot be updated.
Possible values: [string, integer, boolean, float]
use_as_url_slugboolean
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_orderinteger
Specifies the order of the field in the User Interface.
Possible values: <= 1000
Default value: 0
Example: 10
links object
selfuri
meta object
timestamps objectrequired
updated_atstringrequired
Specifies the date the entity is created.
Example: 2017-01-10T11:41:19.244Z
created_atstringrequired
Specifies the date the entity is last updated.
Example: 2017-01-10T11:41:19.244Z
validation object
boolean object
allow_null_valuesboolean | null
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.
Default value: true
immutableboolean | null
When set to true, prevents changing the field.
Default value: false
float
iduuid
The unique identifier of the Custom Field.
typestring
Specifies the type of the resource object, use custom_field for Custom Field.
namestring
Specifies the name of this Custom Field.
Possible values: non-empty and <= 255 characters
descriptionstring
Specifies the description for this Custom API.
Possible values: <= 255 characters
slugstring
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.
Possible values: non-empty and <= 63 characters
field_typestring
Specifies the type of the field. This field cannot be updated.
Possible values: [string, integer, boolean, float]
use_as_url_slugboolean
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_orderinteger
Specifies the order of the field in the User Interface.
Possible values: <= 1000
Default value: 0
Example: 10
links object
selfuri
meta object
timestamps objectrequired
updated_atstringrequired
Specifies the date the entity is created.
Example: 2017-01-10T11:41:19.244Z
created_atstringrequired
Specifies the date the entity is last updated.
Example: 2017-01-10T11:41:19.244Z
validation object
float object
min_valueinteger | null
Specifies the minimum whole number that can be stored.
max_valueinteger | null
Specifies the maximum whole number that can be stored.
allow_null_valuesboolean | null
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.
Default value: true
immutableboolean | null
When set to true, prevents changing the field.
Default value: false
integer
iduuid
The unique identifier of the Custom Field.
typestring
Specifies the type of the resource object, use custom_field for Custom Field.
namestring
Specifies the name of this Custom Field.
Possible values: non-empty and <= 255 characters
descriptionstring
Specifies the description for this Custom API.
Possible values: <= 255 characters
slugstring
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.
Possible values: non-empty and <= 63 characters
field_typestring
Specifies the type of the field. This field cannot be updated.
Possible values: [string, integer, boolean, float]
use_as_url_slugboolean
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_orderinteger
Specifies the order of the field in the User Interface.
Possible values: <= 1000
Default value: 0
Example: 10
links object
selfuri
meta object
timestamps objectrequired
updated_atstringrequired
Specifies the date the entity is created.
Example: 2017-01-10T11:41:19.244Z
created_atstringrequired
Specifies the date the entity is last updated.
Example: 2017-01-10T11:41:19.244Z
validation object
integer object
min_valueinteger | null
Specifies the minimum whole number that can be stored.
max_valueinteger | null
Specifies the maximum whole number that can be stored.
allow_null_valuesboolean | null
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.
Default value: true
immutableboolean | null
When set to true, prevents changing the field.
Default value: false
string
iduuid
The unique identifier of the Custom Field.
typestring
Specifies the type of the resource object, use custom_field for Custom Field.
namestring
Specifies the name of this Custom Field.
Possible values: non-empty and <= 255 characters
descriptionstring
Specifies the description for this Custom API.
Possible values: <= 255 characters
slugstring
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.
Possible values: non-empty and <= 63 characters
field_typestring
Specifies the type of the field. This field cannot be updated.
Possible values: [string, integer, boolean, float]
use_as_url_slugboolean
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_orderinteger
Specifies the order of the field in the User Interface.
Possible values: <= 1000
Default value: 0
Example: 10
links object
selfuri
meta object
timestamps objectrequired
updated_atstringrequired
Specifies the date the entity is created.
Example: 2017-01-10T11:41:19.244Z
created_atstringrequired
Specifies the date the entity is last updated.
Example: 2017-01-10T11:41:19.244Z
validation object
string object
min_lengthinteger | null
Specifies the minimum number of characters that can be stored.
Possible values: <= 65535
Example: 1
max_lengthinteger | null
Specifies the minimum number of characters that can be stored.
Possible values: <= 65535
regexstring | null
An RE2 regular expression that used to restrict the specific characters that can be stored.
Possible values: <= 1024 characters
Example: 1
allow_null_valuesboolean
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
Default value: true
uniquestring
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
Possible values: [yes, no]
Default value: no
unique_case_insensitivityboolean
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.
Default value: false
immutableboolean
When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests.
Default value: false

Example (auto)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "name": "string",
    "description": "string",
    "slug": "string",
    "field_type": "string",
    "use_as_url_slug": true,
    "presentation": {
      "sort_order": 10
    },
    "links": {},
    "meta": {
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244Z",
        "created_at": "2017-01-10T11:41:19.244Z"
      }
    },
    "validation": {
      "boolean": {
        "allow_null_values": true
      }
    }
  }
}

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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/fields");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"type\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"slug\": \"string\",\n    \"field_type\": \"string\",\n    \"use_as_url_slug\": true,\n    \"presentation\": {\n      \"sort_order\": 10\n    },\n    \"validation\": {\n      \"boolean\": {\n        \"allow_null_values\": true\n      }\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

custom_api_id — pathrequired

Body

• Example (from schema)
• string_field
• integer_field
• boolean_field
• float_field

{
  "data": {
    "type": "string",
    "name": "string",
    "description": "string",
    "slug": "string",
    "field_type": "string",
    "use_as_url_slug": true,
    "presentation": {
      "sort_order": 10
    },
    "validation": {
      "boolean": {
        "allow_null_values": true
      }
    }
  }
}

ResponseClear

Click the Send API Request button above and see the response here!