Invite users to a network

Invite users to the network using their email addresses. You can also add them to specific groups using partitionIds. Returns the number of successful invitations, existing members, and failed invitations by category.

Endpoints

post /pulse/api/v1/inviteUsersToNetwork

Copy full URL

Request URL

https://ServerDomain/pulse/api/v1/inviteUsersToNetwork

Scope

ZohoPulse.networkAdmin.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

PARAM NAME	DATA TYPE	DESCRIPTION
emailIdsMandatory	String Allowed value:(matches: (?ims)(.*?))	Comma-separated email addresses to invite.
scopeIDMandatory	Long	Network (scope) ID. Required.
memberType	String Allowed value:(matches: ^(MEMBER\|CLIENT\|RESTRICTED_CLIENT\|EXTERNAL_USER_CLIENT\|EXTERNAL_USER_RESTRICTED_CLIENT)$)	Member type: MEMBER, CLIENT, RESTRICTED_CLIENT, EXTERNAL_USER_CLIENT, or EXTERNAL_USER_RESTRICTED_CLIENT. Defaults to MEMBER.
partitionIds	Long	Comma-separated group IDs to add invited users to.

Sample Request

Curl

Java

Python

Deluge

Copied!

curl --request POST \
  --url 'https://connect.zoho.com/pulse/api/v1/inviteUsersToNetwork?scopeID=3000000000008&partitionIds=3000000002143' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

var client = new RestClient("https://connect.zoho.com/pulse/api/v1/inviteUsersToNetwork?scopeID=3000000000008&partitionIds=3000000002143");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52");
IRestResponse response = client.Execute(request);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://connect.zoho.com/pulse/api/v1/inviteUsersToNetwork?scopeID=3000000000008&partitionIds=3000000002143"))
        .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("connect.zoho.com")

headers = { 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" }

conn.request("POST", "/pulse/api/v1/inviteUsersToNetwork?scopeID=3000000000008&partitionIds=3000000002143", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    parameters = "scopeID=value" + "&" + "partitionIds=value";

    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://connect.zoho.com/pulse/api/v1/inviteUsersToNetwork" + "?" + parameters
        type: POST
        headers: headersMap
        connection: connection_name
    ]

    info response;

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

PARAM NAME	DATA TYPE	DESCRIPTION
inviteUsersToNetwork	JSON Object	Inner inviteUsersToNetwork object — success and error keys
successUserCount	String	Number of users successfully invited.
result	String	Result status — 'success' or 'failure'.
reason	String	Human-readable error message. Present on failure.
existingUsers	JSON Array	Array of email addresses already in the network.
addedUsers	JSON Array	Array of email addresses of users directly added (e.g. domain-verified users).
failedUsers	JSON Object	Categorized failure details. Present when some invitations fail.
failedUsersWithMessage	JSON Array	Detailed failure objects.
description	String	Human-readable failure reason.
users	JSON Array	Array of failed user emails.
email	String	Email address of the failed user.
sameDomainUsers	JSON Array	Users from the same domain that could not be invited.
otherFailedUsers	JSON Array	Invalid email addresses or other failures.
sameOrgUsers	JSON Array	Users already in the same org.
otherRegionUsers	JSON Array	Users in a different data center region.
rejectedUsers	JSON Array	Rejected email addresses.
maxLimitExceeded	JSON Array	Emails that exceeded the user limit.

Possible Response Codes

HTTP Code	Description
200	Success response

Sample Response: HTTP 200

All users were successfully invited to the network.

Copied!

  {
    "inviteUsersToNetwork": {
      "successUserCount": "1",
      "result": "success"
    }
  }

▼ Show full

Returned when the caller is not a network admin or does not have permission to invite users.

Copied!

  {
    "inviteUsersToNetwork": {
      "result": "failure",
      "reason": "Access denied"
    }
  }

▼ Show full

Some users were invited, some already existed, and some had invalid emails.

Copied!

  {
    "inviteUsersToNetwork": {
      "successUserCount": "1",
      "result": "success",
      "existingUsers": [
        "alice@zillium.com"
      ],
      "failedUsers": {
        "otherFailedUsers": [
          "invalid-email"
        ]
      }
    }
  }

▼ Show full

Duration: 1 minute | Threshold: 10 | Lock period: 1 minute

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.