PUT/stages/:id/

Update stage

You can update a specific stage.

Attributes	Type	Required	Description
id	integer	yes	A unique identifier for the stage which is given by User.com automatically.
description	string	yes	A stage description.
name	string	yes	A stage name.
pipeline	integer	yes	A unique identifier for the pipeline which is given by User.com automatically.

Request

CURL

curl -X PUT -H "Authorization: Token <your_64_char_api_key>" -H "Content-Type: application/json" 
       -H "Accept: */*; version=2" -d '{
      "pipeline": "6179"
      "name": "Updated stage"
      "description": "your description"
    }' "https://<your_app_subdomain>.user.com/api/public/stages/:id/"

JavaScript

var data = JSON.stringify({
  "pipeline": "6179"
  "name": "Updated stage"
  "description": "your description"
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://<your_app_subdomain>.user.com/api/public/stages/<id>/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.setRequestHeader("accept", "*/*; version=2");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

PHP

  <?php

  $curl = curl_init();

  curl_setopt_array($curl, array(
    CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/stages/` /<id>`/,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_POSTFIELDS => "{\n  \"pipeline\": \"6179\", \"name\": \"New pipeline\", \"description\": \"your decsription\"  \n}",
    CURLOPT_HTTPHEADER => array(
      "Accept: */*; version=2",
      "authorization: Token <your_64_char_api_key>",
      "content-type: application/json"
    ),
  ));

  $response = curl_exec($curl);
  $err = curl_error($curl);

  curl_close($curl);

  if ($err) {
    echo "cURL Error #:" . $err;
  } else {
    echo $response;
  }

Python

import requests
    
url = "https://<your_app_subdomain>.user.com/api/public/stages/` /<id>`/"

payload = "{\n  \"pipeline\": \"6179\", \"name\": \"New pipeline\", \"description\": \"your decsription\"  \n}",
headers = {
    'authorization': "Token <your_64_char_api_key>",
     'Accept': "*/*; version=2",
    'content-type': "application/json"
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

Response

{
    "id": 36584,
    "name": "Updated stage",
    "description": "your description",
    "pipeline": 6179,
    "order": 0
}

Response