Skip to main content
POST
/
ingest
/
v2
/
{originId}
Save entity
curl --request POST \
  --url https://api.enterspeed.com/ingest/v2/{originId} \
  --header 'Content-Length: <content-length>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --header 'X-Enterspeed-Type: <x-enterspeed-type>' \
  --data '
{
  "name": "Official Enterspeed T-shirt",
  "price": 199.99,
  "inStock": true,
  "features": [
    {
      "name": "color",
      "value": "blue"
    },
    {
      "name": "size",
      "value": "M"
    }
  ],
  "information": {
    "short": "Nice t-shirt",
    "long": "Nice t-shirt in cotton."
  }
}
'
{
  "status": 200,
  "message": "Processing has been initiated."
}

Headers

​
X-Api-Key
string
required

Api key to validate your source.

Example:

"source-90880177-e9a1-47b3-9a40-7b728a6bafd8"

​
X-Enterspeed-Type
string
required

The type or alias of the type of entity being send to process. Eg. blogList, blogPage, frontPage, etc. Only used for raw body

The type is immutable after initial ingest. If an entity with the same originId already exists and the type differs, the ingest will be rejected with a type change error in the response. Type comparison is case-sensitive. To change the entity type, delete the entity and re-ingest with the new type, or use X-Enterspeed-Force-Type to override.

Example:

"product"

​
X-Enterspeed-Force-Type
string

Optional header to override type immutability validation. Include this header to bypass the type immutability check and allow re-ingesting an entity with a different type. This is a destructive operation that rebuilds affected views. Use only when intentional type changes are required.

The value needs to be one of true, TRUE, 1.

Example:

"true"

​
X-Enterspeed-Url
string

If the entity is routable send the URL. Skip if entity is not routable. Only used for raw body. Note: The URL needs to begin with a leading slash.

Example:

"/product-1"

​
X-Enterspeed-OriginParentId
string

Allowed as null if no hierarchy exists. Only used for raw body

Example:

"2"

​
X-Enterspeed-Redirects
string

Comma separated list of URLs that redirects to the current page. Eg. https://enterspeed.com/product-1-old/ redirecting to https://enterspeed.com/product-1/.

Example:

"/product-old,/product-very-old"

​
Content-Length
number
required

The length of the message body, in bytes (this header is automatically added by most clients).

Note: The endpoint does not support Transfer-Encoding: chunked. JsonContent and PostAsJsonAsync in .NET will by default set the Transfer-Encoding: chunked header. Use types like e.g. StringContent or ByteArrayContent instead.

Path Parameters

​
originId
string
required

Id of the entity. Must be same format for all entities within the same source. Eg. integers, guids, etc.

Example:

"1"

Body

application/json

The entity to process

Headers required

​
{key}

Property names:

  • cannot start with a digit
  • cannot consist only of underscores
  • can contain A-Z, a-z letters, digits and underscores

Response

Valid request. Processing of posted entity has begun or source entity hasn't changed and won't be processed.

​
status
number
Example:

200

​
message
string
Example:

"Processing has been initiated."