TEAM MEMBERS API

Manage resources and operations related to team members.

Data Center:

GET Get Team Members

GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members

Retrieves the members present in a team.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.
team_id	string	path	Required	The unique ID of the team associated with the edition.

Responses

200 success

200 using filter fields

404 team not found

401 user not part of the team

success - Response

{
  "data": {
    "team_members": [
      {
        "role_name": "MEMBER",
        "added_time": "Tue, 21 Jan 2025, 13:29:58",
        "modified_time": "Tue, 21 Jan 2025, 13:29:58",
        "mail_id": "test@zohotest.com",
        "added_by": "85572741",
        "display_name": "naga",
        "zuid": "96384499"
      },
      {
        "role_name": "TEAM_ADMIN",
        "added_time": "Sat, 30 Nov 2024, 22:32:11",
        "modified_time": "Sat, 30 Nov 2024, 22:32:11",
        "mail_id": "testadmin@zohotest.com",
        "added_by": "85572741",
        "display_name": "naga.vg+1dev",
        "zuid": "85572741"
      }
    ]
  },
  "message": "Team members fetched successfully.",
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000450001/members",
  "status": "success"
}

using filter fields - Response

{
  "data": {
    "team_members": [
      {
        "mail_id": "test@zohotest.com",
        "added_by": "80215739",
        "added_time": "Sun, 05 Jan 2025, 12:33:30"
      },
      {
        "mail_id": "testadmin@zohotest.com",
        "added_by": "80215739",
        "added_time": "Fri, 03 Jan 2025, 11:55:58"
      }
    ]
  },
  "message": "Team members fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members",
  "status": "success"
}

team not found - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1008",
      "edition_id": "75918186",
      "team_id": "3009000000002003",
      "message": "Team not found"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/3009000000002003/members",
  "status": "error"
}

user not part of the team - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1006",
      "edition_id": "75918186",
      "team_id": "693000000008463",
      "message": "User is not a member of the team"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000008463/members",
  "status": "error"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members'),
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.end();

Python

import requests

url = "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        HttpRequest request = requestBuilder
            .GET(HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members";

headers = Map();
headers.put("Authorization", "Bearer YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"
    type: GET
    headers: headers
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

GET Get Team Admins

GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members

Retrieves members with the Team Admin role from a team.

Parameters

Name	Type	In	Required	Description
member_type	string	query	Required	Role of the member to be fetched. The value `TEAM_ADMIN` retrieves only the team admins.
edition_id	string	path	Required	The unique ID of the edition.
team_id	string	path	Required	The unique ID of the team associated with the edition.

Responses

200 success

200 using filter fields

404 team not found

401 user not part of the team

success - Response

{
  "data": {
    "team_admins": [
      {
        "role_name": "TEAM_ADMIN",
        "added_time": "Tue, 21 Jan 2025, 17:05:47",
        "modified_time": "Tue, 21 Jan 2025, 17:05:47",
        "mail_id": "testadmin@zohotest.com",
        "added_by": "96384499",
        "display_name": "test_admin",
        "zuid": "96384499"
      }
    ]
  },
  "message": "Team members fetched successfully.",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005/members",
  "status": "success"
}

using filter fields - Response

{
  "data": {
    "team_admins": [
      {
        "mail_id": "testadmin@zohotest.com",
        "added_by": "85572741",
        "added_time": "Sat, 30 Nov 2024, 22:32:11"
      }
    ]
  },
  "message": "Team members fetched successfully.",
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000450001/members",
  "status": "success"
}

team not found - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1008",
      "edition_id": "75918186",
      "team_id": "69300000045001",
      "message": "Team not found"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/69300000045001/members",
  "status": "error"
}

user not part of the team - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1006",
      "edition_id": "75918186",
      "team_id": "693000000008463",
      "message": "User is not a member of the team"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000008463/members",
  "status": "error"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members'),
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.end();

Python

import requests

url = "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        HttpRequest request = requestBuilder
            .GET(HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members";

headers = Map();
headers.put("Authorization", "Bearer YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"
    type: GET
    headers: headers
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

POST Add Team Member(s)

POST https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members

Add member(s) to a specific team.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.
team_id	string	path	Required	The unique ID of the team associated with the edition.
members_info	string	body	Based on Request	An array of JSON objects containing the member’s email and role. Each object must include: `mail_id`, `role`. Note: Sending just one object will add a single member.
mail_id	string	body	Based on Request	Email of the member
role	string	body	Based on Request	Role to be assigned (`MEMBER` or `TEAM_ADMIN`).

Request Body

JSON

{
  "members_info": [
    {
      "mail_id": "test2@zohotest.com",
      "role": "MEMBER"
    }
  ]
}

Responses

200 success

206 partial

400 already invited

400 license limit reached

401 unauthorized

success - Response

{
  "data": {
    "added_members": [
      {
        "role_name": "MEMBER",
        "invited_time": "Mon, 03 Feb 2025, 23:17:12",
        "edition_id": "97375109",
        "mail_id": "test2@zohotest.com",
        "added_by": "96384499",
        "team_id": "1505000000051031"
      }
    ]
  },
  "message": "Team member added successfully.",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members",
  "status": "success"
}

partial - Response

{
  "data": {
    "failed_members": [
      {
        "mail_id": "test2@zohotest.com",
        "error_message": "Member already invited",
        "error_code": "T1014"
      }
    ],
    "added_members": [
      {
        "role_name": "MEMBER",
        "invited_time": "Mon, 03 Feb 2025, 23:16:13",
        "edition_id": "97375109",
        "mail_id": "test3@zohotest.com",
        "added_by": "96384499",
        "team_id": "1505000000051031"
      },
      {
        "role_name": "TEAM_ADMIN",
        "added_time": "Mon, 03 Feb 2025, 23:16:12",
        "mail_id": "test2admin@zohotest.com",
        "added_by": "96384499",
        "team_id": "1505000000051031"
      }
    ]
  },
  "message": "Partial success: Some members added, others failed.",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members",
  "status": "success"
}

already invited - Response

{
  "error": {
    "details": {
      "failed_members": [
        {
          "mail_id": "test2@zohotest.com",
          "error_message": "Member already part of team",
          "error_code": "T1013"
        }
      ],
      "message": "Team member add failed",
      "error_code": "T1017"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members",
  "status": "error"
}

license limit reached - Response

{
  "error": {
    "details": {
      "failed_members": [
        {
          "error_message": "License limit reached",
          "error_code": "L1001"
        }
      ],
      "message": "Team member add failed",
      "error_code": "T1017"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "97377569",
      "error_code": "A1003",
      "edition_id": "96499735",
      "team_id": "3009000000002003",
      "message": "The user doesn't have permission to perform this action"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members",
  "status": "error"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X POST "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "members_info": [
    {
      "mail_id": "test@gmail.com",
      "role": "MEMBER"
    }
  ]
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "members_info": [
    {
      "mail_id": "test@gmail.com",
      "role": "MEMBER"
    }
  ]
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members'),
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "members_info": [
    {
      "mail_id": "test@gmail.com",
      "role": "MEMBER"
    }
  ]
}));
req.end();

Python

import requests

url = "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "members_info": [
    {
      "mail_id": "test@gmail.com",
      "role": "MEMBER"
    }
  ]
}

response = requests.post(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"members_info\":[{\"mail_id\":\"test@gmail.com\",\"role\":\"MEMBER\"}]}";
        HttpRequest request = requestBuilder
            .POST(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members";

headers = Map();
headers.put("Authorization", "Bearer YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"members_info": {{"mail_id": "test@gmail.com", "role": "MEMBER"}}};

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members"
    type: POST
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

PUT Update Team Member Role

PUT https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}

Updates the role of a specific team member in an edition.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.
team_id	string	path	Required	The unique ID of the team associated with the edition.
member_id	string	path	Required	The user ID (zuid) of the member to be updated.
role	string	body	Based on Request	New role to be assigned to the member (`MEMBER` or `TEAM_ADMIN`).

Request Body

JSON

{
  "role": "TEAM_ADMIN"
}

Responses

200 success - admin

200 success - member

409 has same role

403 cannot update own role

403 super admin can't update

404 member not part of the team

401 non team member try to update role

401 unauthorized

success - admin - Response

{
  "data": {
    "current_user_id": "96384499",
    "new_role": "TEAM_ADMIN",
    "edition_id": "75918186",
    "team_id": "693000000436009",
    "zuid": "81479212"
  },
  "message": "Team member updated successfully.",
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/members",
  "status": "success"
}

success - member - Response

{
  "data": {
    "current_user_id": "96384499",
    "new_role": "MEMBER",
    "edition_id": "97375109",
    "team_id": "1505000000051031",
    "zuid": "98722154"
  },
  "message": "Team member updated successfully.",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members",
  "status": "success"
}

has same role - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "M1001",
      "edition_id": "75918186",
      "team_id": "693000000436009",
      "message": "The member already has the specified role",
      "zuid": "81479212"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/members",
  "status": "error"
}

cannot update own role - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "R1001",
      "edition_id": "97375109",
      "team_id": "1505000000002005",
      "message": "Cannot update own role",
      "zuid": "96384499"
    }
  },
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005/members",
  "status": "error"
}

super admin can't update - Response

{
  "error": {
    "details": {
      "current_user_id": "85572741",
      "error_code": "A1006",
      "edition_id": "97375109",
      "team_id": "1505000000002005",
      "message": "Super admin can't be updated",
      "zuid": "96384499"
    }
  },
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005/members",
  "status": "error"
}

member not part of the team - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1012",
      "edition_id": "97375109",
      "team_id": "1505000000051031",
      "message": "Member not part of team",
      "zuid": "80215739"
    }
  },
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members",
  "status": "error"
}

non team member try to update role - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1006",
      "edition_id": "75918186",
      "team_id": "693000000436009",
      "message": "User is not a member of the team"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/members",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1002",
      "edition_id": "75918186",
      "team_id": "693000000436009",
      "message": "Only admin can do this action"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/members",
  "status": "error"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X PUT "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "TEAM_ADMIN"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "role": "TEAM_ADMIN"
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}'),
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "role": "TEAM_ADMIN"
}));
req.end();

Python

import requests

url = "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "role": "TEAM_ADMIN"
}

response = requests.put(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"role\":\"TEAM_ADMIN\"}";
        HttpRequest request = requestBuilder
            .PUT(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}";

headers = Map();
headers.put("Authorization", "Bearer YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"role": "TEAM_ADMIN"};

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}"
    type: PUT
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

DELETE Remove Team Member

DELETE https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}

Removes a specific member from a team in an edition.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.
team_id	string	path	Required	The unique ID of the team associated with the edition.
member_id	string	path	Required	The user ID (zuid) of the member to be deleted.
assign_to_zuid	string	body	Based on Request	The user ID (zuid) to whom the removed member’s records should be reassigned.

Request Body

JSON

{
  "assign_to_zuid": "96384499"
}

Responses

200 success

403 self remove

403 super admin can't remove

404 member not part of team

403 unauthorized

success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "97375109",
    "team_id": "1505000000051031",
    "removed_zuid": "97377569"
  },
  "message": "Team member deleted successfully.",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members",
  "status": "success"
}

self remove - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1020",
      "edition_id": "97375109",
      "team_id": "1505000000051031",
      "message": "Cannot remove self from the team"
    }
  },
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members",
  "status": "error"
}

super admin can't remove - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1004",
      "edition_id": "96499735",
      "team_id": "3009000000002003",
      "message": "Super admin can't be removed from the team"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members",
  "status": "error"
}

member not part of team - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1012",
      "edition_id": "97375109",
      "team_id": "1505000000051031",
      "message": "Member not part of team"
    }
  },
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1002",
      "edition_id": "96499735",
      "team_id": "3009000000002003",
      "message": "Only admin can do this action"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members",
  "status": "error"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X DELETE "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "assign_to_zuid": "85572741"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "assign_to_zuid": "85572741"
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}'),
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "assign_to_zuid": "85572741"
}));
req.end();

Python

import requests

url = "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "assign_to_zuid": "85572741"
}

response = requests.delete(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"assign_to_zuid\":\"85572741\"}";
        HttpRequest request = requestBuilder
            .DELETE(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}";

headers = Map();
headers.put("Authorization", "Bearer YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"assign_to_zuid": "85572741"};

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}"
    type: DELETE
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}