Delete group

Deletes a group in a team.

HTTP method and URL path

DELETE https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}

Authentication and authorization

This endpoint requires a valid access token that was generated using client credentials.

Scopes

The access token must have all the following scopes (permissions):

admin:group:write

Header parameters

Authorizationstring

Required

Provides credentials to authenticate the request, in the form of a Bearer token.

For example: Authorization: Bearer {token}

Path parameters

teamIdstring

Required

The team ID.

groupIdstring

Required

The group ID.

Example request

Examples for using the /v1/teams/{teamId}/groups/{groupId} endpoint:

curl --request DELETE 'https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}' \
--header 'Authorization: Bearer {token}'

const fetch = require("node-fetch");

fetch("https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {token}",
  },
})
  .then(async (response) => {
    const data = await response.json();
    console.log(data);
  })
  .catch(err => console.error(err));

import java.io.IOException;
import java.net.URI;
import java.net.http.*;

public class ApiExample {
    public static void main(String[] args) throws IOException, InterruptedException {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}"))
            .header("Authorization", "Bearer {token}")
            .method("DELETE", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(
            request,
            HttpResponse.BodyHandlers.ofString()
        );
        System.out.println(response.body());
    }
}

JAVA

import requests

headers = {
    "Authorization": "Bearer {token}"
}

response = requests.delete("https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}",
    headers=headers
)
print(response.json())

using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
  },
};

using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
};

CSHARP

package main

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

func main() {
	url := "https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}"
	req, _ := http.NewRequest("DELETE", url, nil)
	req.Header.Add("Authorization", "Bearer {token}")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}",
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer {token}',
  ),
));

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

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

PHP

require 'net/http'
require 'uri'

url = URI('https://api.canva.com/admin/v1/teams/{teamId}/groups/{groupId}')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request['Authorization'] = 'Bearer {token}'

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

RUBY

Success response

If successful, the endpoint returns the status code 204 No content without a response body.

Error responses

404 Not Found

codestring

A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see Error responses.

messagestring

A human-readable description of what went wrong.

Example error responses

The team was not found

{
  "code": "team_not_found",
  "message": "Team {teamId} not found"
}

JSON

The group was not found

{
  "code": "group_not_found",
  "message": "Group {groupId} not found"
}

JSON