Update A Custom Entry

Update a Custom API Entry

PUT/v2/settings/extensions/custom-apis/{custom-api-id}/entries/{custom-api-entry-id}

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Update A Custom Entry action (under Commerce Extensions).
Fill in the fields below, then reference the result from later steps as {{updateACustomEntry.response.data}}.

Request

Path parameters

custom-api-idstring (uuid)required

The unique identifier of the Custom API.

custom-api-entry-idstring (uuid)required

The unique identifier of the Custom API Entry.

Headers

If-Matchstring (string)required

When If-Match is set, the value must be W/"{etag_id}". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.

Response

Returns 200 with an object. Read it in later steps with {{updateACustomEntry.response.data.<field>}}.

dataobject

idstring (uuid)

The unique identifier for the Custom API Entry.

typestring

Specifies the type of the resource object, use the `api_type` of the [Custom API](/docs/api/commerce-extensions/create-a-custom-api) for Custom API Entry.

linksobject1 fields

metaany

json

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "string",
    "links": {
      "self": "string"
    },
    "meta": null
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?