Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Api / Features

Method Description
🔹 advance() Advance feature
🔹 create() Create feature
🔹 delete() Delete feature
🔹 list() List features
🔹 read() Fetch feature
🔹 update() Update feature

📚 Features API Reference

Getting started

// Place your API Key 👇 here
$sdk = new \Kronup\Sdk();

// API Call
$sdk->api()->features();

advance()

Advance a feature

#️⃣ Execute example in terminal

php -f advance.php

Request

PUT /teams/{teamId}/channels/{channelId}/features/{featureId}

Type signature

(new \Kronup\Sdk())->api()->features()->advance(
    string $team_id,
    string $channel_id,
    string $feature_id
): \Kronup\Model\Feature

Parameters

Name Type Description
$team_id string Team ID
$channel_id string Channel ID
$feature_id string Feature ID

Return type

\Kronup\Model\Feature

🔺 Back to top


create()

Add a feature to planning

#️⃣ Execute example in terminal

php -f create.php

Request

POST /teams/{teamId}/channels/{channelId}/features

Type signature

(new \Kronup\Sdk())->api()->features()->create(
    string $team_id,
    string $channel_id,
    \Kronup\Model\PayloadFeatureCreate $payload_feature_create
): \Kronup\Model\Feature

Parameters

Name Type Description
$team_id string Team ID
$channel_id string Channel ID
$payload_feature_create \Kronup\Model\PayloadFeatureCreate  

Return type

\Kronup\Model\Feature

🔺 Back to top


delete()

Delete a feature from the flow

#️⃣ Execute example in terminal

php -f delete.php

Request

DELETE /teams/{teamId}/channels/{channelId}/features/{featureId}

Type signature

(new \Kronup\Sdk())->api()->features()->delete(
    string $team_id,
    string $channel_id,
    string $feature_id
): bool

Parameters

Name Type Description
$team_id string Team ID
$channel_id string Channel ID
$feature_id string Feature ID

Return type

bool

🔺 Back to top


list()

Get a list of feature models

#️⃣ Execute example in terminal

php -f list.php

Request

GET /teams/{teamId}/channels/{channelId}/features

Type signature

(new \Kronup\Sdk())->api()->features()->list(
    string $team_id,
    string $channel_id,
    [ string $stage, ]
    [ int $page_number = 1, ]
    [ int $page_size = 500 ]
): \Kronup\Model\FeaturesList

Parameters

Name Type Description
$team_id string Team ID
$channel_id string Channel ID
$stage string Feature stage
$page_number int [default to 1]
$page_size int [default to 500]

Return type

\Kronup\Model\FeaturesList

🔺 Back to top


read()

Retrieve feature model

#️⃣ Execute example in terminal

php -f read.php

Request

GET /teams/{teamId}/channels/{channelId}/features/{featureId}

Type signature

(new \Kronup\Sdk())->api()->features()->read(
    string $team_id,
    string $channel_id,
    string $feature_id
): \Kronup\Model\Feature

Parameters

Name Type Description
$team_id string Team ID
$channel_id string Channel ID
$feature_id string Feature ID

Return type

\Kronup\Model\Feature

🔺 Back to top


update()

Update feature details

#️⃣ Execute example in terminal

php -f update.php

Request

POST /teams/{teamId}/channels/{channelId}/features/{featureId}

Type signature

(new \Kronup\Sdk())->api()->features()->update(
    string $team_id,
    string $channel_id,
    string $feature_id,
    \Kronup\Model\PayloadFeatureUpdate $payload_feature_update
): \Kronup\Model\Feature

Parameters

Name Type Description
$team_id string Team ID
$channel_id string Channel ID
$feature_id string Feature ID
$payload_feature_update \Kronup\Model\PayloadFeatureUpdate  

Return type

\Kronup\Model\Feature

🔺 Back to top