TEAM MEMBERS - Vani API Documentation

GET Fetch Team Members

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

Required Scopes:

vani.teams.read

Retrieves the members present in a team.

Parameters

Name	Type	In	Required	Description
fields	string	query	Optional	Specifies the fields (comma-separated) to retrieve. Allowed values: `zuid`,`role_name`,`added_time`,`added_by`,`modified_time`, `display_name`,`mail_id`,`team_id`.
from	string	query	Optional	The starting index from where the results should be fetched. Default value is 0.
limit	string	query	Optional	The maximum number of results to return in the response. Default value is 20.
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 Pagination

404 Team Not Found

401 User Is Not Part of the Team

200 Using Filter Fields

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": "emma.carter@boxicle.com",
        "added_by": "85572741",
        "display_name": "Emma Carter",
        "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": "ryan.mitchell@boxicle.com",
        "added_by": "85572741",
        "display_name": "Ryan Mitchell",
        "zuid": "85572741"
      }
    ]
  },
  "message": "Team members fetched successfully.",
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000450001/members",
  "status": "success"
}

Code Examples

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 "x-vani-apikey: YOUR_API_KEY" \
  -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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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",
    "x-vani-apikey": "YOUR_API_KEY",
    "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("x-vani-apikey", "YOUR_API_KEY")
            .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("x-vani-apikey", "YOUR_API_KEY");
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 Fetch Team Admins

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

Required Scopes:

vani.teams.read

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.
fields	string	query	Optional	Specifies the fields (comma-separated) to retrieve. Allowed values: `zuid`,`role_name`,`added_time`,`added_by`,`modified_time`, `display_name`,`mail_id`,`team_id`.
from	string	query	Optional	The starting index from where the results should be fetched. Default value is 0.
limit	string	query	Optional	The maximum number of results to return in the response. Default value is 20.
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

404 Team Not Found

401 User Is Not Part of the Team

200 Using Filter Fields

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": "ryan.mitchell@boxicle.com",
        "added_by": "96384499",
        "display_name": "Ryan Mitchell",
        "zuid": "96384499"
      }
    ]
  },
  "message": "Team members fetched successfully.",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005/members",
  "status": "success"
}

Code Examples

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 "x-vani-apikey: YOUR_API_KEY" \
  -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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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",
    "x-vani-apikey": "YOUR_API_KEY",
    "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("x-vani-apikey", "YOUR_API_KEY")
            .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("x-vani-apikey", "YOUR_API_KEY");
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

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

Required Scopes:

vani.teams.create

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	Required	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	Required	Email of the member
role	string	body	Required	Role to be assigned (`MEMBER` or `TEAM_ADMIN`).

Request Body

JSON

{
  "members_info": [
    {
      "mail_id": "sophia.bennett@boxicle.com",
      "role": "MEMBER"
    }
  ]
}

Responses

200 Success

206 Partial Success

400 Member Already Part of the Team

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": "sophia.bennett@boxicle.com",
        "added_by": "96384499",
        "team_id": "1505000000051031"
      }
    ]
  },
  "message": "Team member added successfully.",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members",
  "status": "success"
}

Code Examples

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 "x-vani-apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Request body format could not be parsed",
  "raw_content": "{\n    \"members_info\":[ //* An array of JSON objects containing the member’s email and role. Each object must include: <code>mail_id</code>, <code>role</code>. Note: Sending just one object will add a ..."
}'

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',
    'x-vani-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "note": "Request body format could not be parsed",
  "raw_content": "{\n    \"members_info\":[ //* An array of JSON objects containing the member’s email and role. Each object must include: <code>mail_id</code>, <code>role</code>. Note: Sending just one object will add a ..."
})
});

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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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({
  "note": "Request body format could not be parsed",
  "raw_content": "{\n    \"members_info\":[ //* An array of JSON objects containing the member’s email and role. Each object must include: <code>mail_id</code>, <code>role</code>. Note: Sending just one object will add a ..."
}));
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",
    "x-vani-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
  "note": "Request body format could not be parsed",
  "raw_content": "{\n    \"members_info\":[ //* An array of JSON objects containing the member’s email and role. Each object must include: <code>mail_id</code>, <code>role</code>. Note: Sending just one object will add a ..."
}

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("x-vani-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"note\":\"Request body format could not be parsed\",\"raw_content\":\"{\n    \\"members_info\\":[ //* An array of JSON objects containing the member’s email and role. Each object must include: <code>mail_id</code>, <code>role</code>. Note: Sending just one object will add a ...\"}";
        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("x-vani-apikey", "YOUR_API_KEY");
headers.put("Content-Type", "application/json");

requestData = {"note": "Request body format could not be parsed", "raw_content": "{
    \"members_info\":[ //* An array of JSON objects containing the member’s email and role. Each object must include: <code>mail_id</code>, <code>role</code>. Note: Sending just one object will add a ..."};

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}

Required Scopes:

vani.teams.update

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	Required	New role to be assigned to the member (`MEMBER` or `TEAM_ADMIN`).

Request Body

JSON

{
  "role": "TEAM_ADMIN"
}

Responses

200 Success – Admin Role Assigned

200 Success – Member Role Assigned

409 Member Already Has the Specified Role

403 Cannot Update Own Role

403 Super Admin Role Cannot Be Updated

404 Member Not Part of the Team

401 Non-Team Member Attempted Role Update

401 Unauthorized

Success – Admin Role Assigned - 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"
}

Code Examples

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 "x-vani-apikey: YOUR_API_KEY" \
  -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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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",
    "x-vani-apikey": "YOUR_API_KEY",
    "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("x-vani-apikey", "YOUR_API_KEY")
            .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("x-vani-apikey", "YOUR_API_KEY");
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}

Required Scopes:

vani.teams.delete

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	Required	The user ID (zuid) to whom the removed member’s records should be reassigned.

Request Body

JSON

{
  "assign_to_zuid": 97377569
}

Responses

200 Success

403 Cannot Remove Self from the Team

403 Super Admin Cannot Be Removed from the Team

404 Member Not Part of the 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"
}

Code Examples

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 "x-vani-apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "assign_to_zuid": "{{assign_to_zuid}}"
}'

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',
    'x-vani-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "assign_to_zuid": "{{assign_to_zuid}}"
})
});

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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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": "{{assign_to_zuid}}"
}));
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",
    "x-vani-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
  "assign_to_zuid": "{{assign_to_zuid}}"
}

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("x-vani-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"assign_to_zuid\":\"{{assign_to_zuid}}\"}";
        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("x-vani-apikey", "YOUR_API_KEY");
headers.put("Content-Type", "application/json");

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

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");
}

TEAM MEMBERS API

GET Fetch Team Members

Required Scopes:

Parameters

Responses

Code Examples

GET Fetch Team Admins

Required Scopes:

Parameters

Responses

Code Examples

POST Add Team Member

Required Scopes:

Parameters

Request Body

Responses

Code Examples

PUT Update Team Member Role

Required Scopes:

Parameters

Request Body

Responses

Code Examples

DELETE Remove Team Member

Required Scopes:

Parameters

Request Body

Responses

Code Examples