Update teams

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/teams \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "Optional comment about the update",
  "instructions": [
    {
      "kind": "addMembersToTeams",
      "memberIDs": [
        "1234a56b7c89d012345e678f"
      ],
      "teamKeys": [
        "example-team-1",
        "example-team-2"
      ]
    }
  ]
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/teams"

payload = {
    "comment": "Optional comment about the update",
    "instructions": [
        {
            "kind": "addMembersToTeams",
            "memberIDs": ["1234a56b7c89d012345e678f"],
            "teamKeys": ["example-team-1", "example-team-2"]
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comment: 'Optional comment about the update',
    instructions: [
      {
        kind: 'addMembersToTeams',
        memberIDs: ['1234a56b7c89d012345e678f'],
        teamKeys: ['example-team-1', 'example-team-2']
      }
    ]
  })
};

fetch('https://app.launchdarkly.com/api/v2/teams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/teams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => 'Optional comment about the update',
    'instructions' => [
        [
                'kind' => 'addMembersToTeams',
                'memberIDs' => [
                                '1234a56b7c89d012345e678f'
                ],
                'teamKeys' => [
                                'example-team-1',
                                'example-team-2'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/teams"

	payload := strings.NewReader("{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"addMembersToTeams\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\"\n      ],\n      \"teamKeys\": [\n        \"example-team-1\",\n        \"example-team-2\"\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/teams")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"addMembersToTeams\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\"\n      ],\n      \"teamKeys\": [\n        \"example-team-1\",\n        \"example-team-2\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/teams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"addMembersToTeams\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\"\n      ],\n      \"teamKeys\": [\n        \"example-team-1\",\n        \"example-team-2\"\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "memberIDs": [
    "1234a56b7c89d012345e678f"
  ],
  "teamKeys": [
    "example-team-1"
  ],
  "errors": [
    {
      "example-team-2": "example failure message"
    }
  ]
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "optimistic_locking_error",
  "message": "Conflict. Optimistic lock error. Try again later."
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Update teams

Perform a partial update to multiple teams. Updating teams uses the semantic patch format.

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

Semantic patch requests support the following kind instructions for updating teams.

Click to expand instructions for updating teams

addMembersToTeams

Add the members to teams.

Parameters

memberIDs: List of member IDs to add.
teamKeys: List of teams to update.

Here’s an example:

{
  "instructions": [{
    "kind": "addMembersToTeams",
    "memberIDs": [
      "1234a56b7c89d012345e678f"
    ],
    "teamKeys": [
      "example-team-1",
      "example-team-2"
    ]
  }]
}

addAllMembersToTeams

Add all members to the team. Members that match any of the filters are excluded from the update.

Parameters

teamKeys: List of teams to update.
filterLastSeen: (Optional) A JSON object with one of the following formats:
- {"never": true} - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM.
- {"noData": true} - Members that have not been active since LaunchDarkly began recording last seen timestamps.
- {"before": 1608672063611} - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds.
filterQuery: (Optional) A string that matches against the members’ emails and names. It is not case sensitive.
filterRoles: (Optional) A | separated list of roles and custom roles. For the purposes of this filtering, Owner counts as Admin.
filterTeamKey: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive.
ignoredMemberIDs: (Optional) A list of member IDs.

Here’s an example:

{
  "instructions": [{
    "kind": "addAllMembersToTeams",
    "teamKeys": [
      "example-team-1",
      "example-team-2"
    ],
    "filterLastSeen": { "never": true }
  }]
}

PATCH

api

teams

Update teams

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/teams \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "Optional comment about the update",
  "instructions": [
    {
      "kind": "addMembersToTeams",
      "memberIDs": [
        "1234a56b7c89d012345e678f"
      ],
      "teamKeys": [
        "example-team-1",
        "example-team-2"
      ]
    }
  ]
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/teams"

payload = {
    "comment": "Optional comment about the update",
    "instructions": [
        {
            "kind": "addMembersToTeams",
            "memberIDs": ["1234a56b7c89d012345e678f"],
            "teamKeys": ["example-team-1", "example-team-2"]
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comment: 'Optional comment about the update',
    instructions: [
      {
        kind: 'addMembersToTeams',
        memberIDs: ['1234a56b7c89d012345e678f'],
        teamKeys: ['example-team-1', 'example-team-2']
      }
    ]
  })
};

fetch('https://app.launchdarkly.com/api/v2/teams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/teams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => 'Optional comment about the update',
    'instructions' => [
        [
                'kind' => 'addMembersToTeams',
                'memberIDs' => [
                                '1234a56b7c89d012345e678f'
                ],
                'teamKeys' => [
                                'example-team-1',
                                'example-team-2'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/teams"

	payload := strings.NewReader("{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"addMembersToTeams\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\"\n      ],\n      \"teamKeys\": [\n        \"example-team-1\",\n        \"example-team-2\"\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/teams")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"addMembersToTeams\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\"\n      ],\n      \"teamKeys\": [\n        \"example-team-1\",\n        \"example-team-2\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/teams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"addMembersToTeams\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\"\n      ],\n      \"teamKeys\": [\n        \"example-team-1\",\n        \"example-team-2\"\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "memberIDs": [
    "1234a56b7c89d012345e678f"
  ],
  "teamKeys": [
    "example-team-1"
  ],
  "errors": [
    {
      "example-team-2": "example failure message"
    }
  ]
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "optimistic_locking_error",
  "message": "Conflict. Optimistic lock error. Try again later."
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Body

application/json

instructions

object[]

required

The instructions to perform when updating. This should be an array with objects that look like {"kind": "update_action"}. Some instructions also require additional parameters as part of this object.

Show child attributes

Example:

"[ { \"kind\": \"updateDescription\", \"value\": \"New description for the team\" } ]"

comment

string

Optional comment describing the update

Example:

"Optional comment about the update"

Response

Teams response

memberIDs

string[]

A list of member IDs of the members who were added to the teams.

Example:

["1234a56b7c89d012345e678f"]

teamKeys

string[]

A list of team keys of the teams that were successfully updated.

Example:

["example-team-1"]

errors

object[]

A list of team keys and errors for the teams whose updates failed.

Show child attributes

Example:

[
  {
    "example-team-2": "example failure message"
  }
]