Update a Custom Field

PUT 
/v2/settings/extensions/custom-apis/:customApiId/fields/:customFieldId

Update a Custom Field

Request

Path Parameters

customApiId uuidrequired
The id of the Custom API.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
customFieldId uuidrequired
The id of the Custom Field.
Example: 859aeba1-03c2-4822-bd4c-89afce93d7eb

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.

links object

meta Meta

timestamps Timestampsrequired

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.

links object

meta Meta

timestamps Timestampsrequired

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.

regexp integernull

Possible values: <= 1024 characters

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

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.

links object

meta Meta

timestamps Timestampsrequired

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.

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.

links object

meta Meta

timestamps Timestampsrequired

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.

Responses

200

OK

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.

links object

self uri

meta Meta

timestamps Timestampsrequired

updated_at stringrequired

Specifies the date the entity is created.

created_at stringrequired

Specifies the date the entity is last updated.

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.

links object

self uri

meta Meta

timestamps Timestampsrequired

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.

regexp integernull

Possible values: <= 1024 characters

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

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.

links object

self uri

meta Meta

timestamps Timestampsrequired

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.

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.

links object

self uri

meta Meta

timestamps Timestampsrequired

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.

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
      }
    },
    "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": 0,
        "max_value": null
      }
    },
    "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",
    "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"
    }
  ]
}

default

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...