POST
/
v4
/
deployment-packages
/
{account_id}
/
install
import SGPClient from 'sgp';

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

async function main() {
  const installDeploymentPackageResponse = await client.deploymentPackages.install('account_id');

  console.log(installDeploymentPackageResponse.package_installation);
}

main();
{
  "package_installation": {
    "organization_id": "<string>",
    "package_version_id": "<string>",
    "status": "INSTALLED",
    "install_log": "<string>",
    "state": {},
    "account_id": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by_user_id": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

account_id
string
required

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.