Skip to main content
POST
/
api
/
v1
/
addons
/
{id}
/
publish
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.addons.publish('x', { migrationType: 'NEW_CUSTOMERS' });

console.log(response.data);
{
  "data": {
    "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Headers

​
X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

​
X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

​
id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Request to publish an addon draft

​
migrationType
enum<string>
required

The migration type of the package

Available options:
NEW_CUSTOMERS,
ALL_CUSTOMERS

Response

A task ID for tracking the async publish operation.

Response containing task ID for publish operation

​
data
object
required