Publish

Publish built campaigns and pages to make them live on your storefront. Requires a prior successful build.

Publish Campaigns and Pages

post

This API allows you to publish campaigns and pages in Limio. You can use this API to publish campaigns and pages to make them live on your website. This can be useful for activities such as launching new products, promoting sales, or creating seasonal campaigns.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Body

application/json

tagsarrayOptional

The list of campaigns and pages to publish

Example: ["/tags/uk-uk/default"]

buildIdstringOptional

The build ID of the campaigns and pages to publish

Example: build-shard-shop:b83ee127-2301-4358-b993-cb3d7f009718

namestringOptional

The name of one of the campaigns / pages to be published

Example: Default

Responses

200

OK

application/json

successbooleanOptional

Indicates whether the operation was successful

Example: true

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

post

/publish

HTTPcURLJavaScriptPython

POST /api/publish HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "tags": [
    "/tags/uk-uk/default"
  ],
  "buildId": "build-shard-shop:b83ee127-2301-4358-b993-cb3d7f009718",
  "name": "Default"
}

{
  "success": true,
  "publishedData": {
    "pages": {
      "/default/": [
        {
          "path": "/default/",
          "isDefault": true,
          "pathPrefix": "/__v/956ec1a_1712754608",
          "type": "page",
          "codebuildId": "build-shard-shop:b83ee127-2301-4358-b993-cb3d7f009718",
          "buildDate": "2024-04-10T13:11:05.534Z",
          "name": "Campaign",
          "publishedDate": "2024-04-10T13:13:05.081Z",
          "userName": "[email protected]"
        }
      ],
      "/checkout/": [
        {
          "path": "/checkout/",
          "isDefault": false,
          "pathPrefix": "/__v/4b09596_1712311159",
          "type": "page",
          "codebuildId": "build-shard-shop:b83ee127-2301-4358-b993-cb3d7f009718",
          "buildDate": "2024-04-05T10:00:39.455Z",
          "name": "Checkout",
          "publishedDate": "2024-04-05T10:01:07.401Z",
          "userName": "[email protected]"
        }
      ]
    }
  },
  "ommitedWithError": {
    "pages": {}
  }
}