Update a Custom API Entry using the settings endpoint

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

Update a Custom API Entry using the settings endpoint

Request

Responses

200

OK

Response Headers

ETag

A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change.

201

Created

Response Headers

ETag

A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change. The ETag hash will be the same value as etag_id, and is marked as a weak entity tag string. For example: etag: W/"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9", etag_id: 5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9

400

Bad request. The request failed validation.

403

Forbidden. You do not have permission to access this resource.

404

Not found. The requested entity does not exist.

409

Unable to perform the operation at this time.

412

Precondition Failed.

413

Payload Too Large. The total size of a Custom API Entry must not exceed 64KB.

500

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

503

The service is temporarily unavailable. This request can be safely retried.

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/entries/:custom_api_entry_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"type\": \"string\"\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_api_entry_id — pathrequired

If-Match — header

Body

• Example (from schema)
• valid_entry

{
  "data": {
    "type": "string"
  }
}

ResponseClear

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