Update a Custom Field

PUT 
https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/fields/:custom_field_id

Update a Custom Field

Request

Responses

200

OK

400

Bad request. The request failed validation.

404

Not found. The requested entity does not exist.

409

Unable to perform the operation at this time.

500

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

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.Put, "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/fields/:custom_field_id");
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

custom_field_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!