Start Sprint tasks.api.scrum.sprint.start

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: YOUR_ACCESS_TOKEN" \
        -d '{
        "id": 2
        }' \
        https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.start
        

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type SprintStartResult = {
          id: number,
          groupId: number,
          entityType: string,
          name: string,
          goal: string,
          sort: number,
          createdBy: number,
          modifiedBy: number,
          dateStart: ISODate | null,
          dateEnd: ISODate | null,
          status: string,
        }
        
        const sprintId = 2
        
        try {
          const response = await $b24.actions.v2.call.make<SprintStartResult>({
            method: 'tasks.api.scrum.sprint.start',
            params: {
              id: sprintId,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Sprint started:', result.id, result.name, result.status)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function startSprint() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const sprintId = 2
        
              const response = await $b24.actions.v2.call.make({
                method: 'tasks.api.scrum.sprint.start',
                params: {
                  id: sprintId,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Sprint started:', result.id, result.name, result.status)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', startSprint)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.tasks.api.scrum.sprint.start(
                bitrix_id=2,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

$sprintId = 2;
        
        try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.sprint.start',
                    [
                        'id' => $sprintId
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error starting sprint: ' . $e->getMessage();
        }
        

const sprintId = 2;
        BX24.callMethod(
            'tasks.api.scrum.sprint.start',
            {
                id: sprintId
            },
            function(res)
            {
                console.log(res);
            }
        );
        

require_once('crest.php'); // CRest PHP SDK connection
        
        // executing a request to the REST API
        $result = CRest::call(
            'tasks.api.scrum.sprint.start',
            [
                'id' => 2,
            ]
        );
        
        // Processing the response from Bitrix24
        if (isset($result['error'])) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "tasks.api.scrum.sprint.start", b24.Params{
        	"id": 2,
        })
        if err != nil {
        	return fmt.Errorf("tasks.api.scrum.sprint.start: %w", err)
        }
        
        var item struct {
        	ID         b24.ID `json:"id"`
        	GroupID    b24.ID `json:"groupId"`
        	EntityType string `json:"entityType"`
        	Name       string `json:"name"`
        	Goal       string `json:"goal"`
        	Sort       int    `json:"sort"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.GroupID)