> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.heyreach.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.heyreach.io/_mcp/server. # InviteMembers POST https://api//api/public/management/organizations/users/invite/members Content-Type: application/json Invite one or multiple users in your organization. Specify the relevant permissions for each invited user. The invitation emails will not be sent, only an invitation URL is generated. You can send this URL to the relevant user in order to register them to HeyReach. Reference: https://docs.heyreach.io/hey-reach-api/organization/workspace-users/invite-members ## Request ### Headers - `X-API-KEY` (string, optional) — Workspace API Key ### Body (application/json) This endpoint expects an object. - `inviterEmail` (string, required) - `workspaceIds` (list of integer, required) - `permissions` (object, required) - `viewLinkedInSenders` (boolean, required) - `manageLinkedInSendersSettings` (boolean, required) - `viewLeadLists` (boolean, required) - `importEditManageLeadLists` (boolean, required) - `viewMyNetwork` (boolean, required) - `viewCampaigns` (boolean, required) - `editManageCampaigns` (boolean, required) - `viewLinkedInSenderInboxes` (boolean, required) - `replyFromLinkedInSenderInboxes` (boolean, required) - `viewIntegrations` (boolean, required) - `manageIntegrations` (boolean, required) - `exportDataToCRMs` (boolean, required) - `viewNotifications` (boolean, required) - `manageNotifications` (boolean, required) - `emails` (list of string, required) ## Response ### 200 OK - `list of object` - `workspaces` (list of object, required) - `workspaceId` (integer, required) - `success` (boolean, required) - `errorCode` (string, required) - `errorMessage` (string, required) - `invitationId` (integer, required) - `invitationStatus` (string, required) - `invitationUrl` (string, required) - `invitationExpirationTime` (datetime, required) - `emailAddress` (string, required) ## Errors ### 400 Invite Members Workspace Users Request Bad Request Error Bad Request - `type` (string, required) - `title` (string, required) - `status` (integer, required) - `detail` (string, required) - `instance` (string, required) ### 401 Invite Members Workspace Users Request Unauthorized Error Unauthorized - `type` (string, required) - `title` (string, required) - `status` (integer, required) - `detail` (string, required) - `instance` (string, required) ### 429 Invite Members Workspace Users Request Too Many Requests Error Too Many Requests - `type` (string, required) - `title` (string, required) - `status` (integer, required) - `detail` (string, required) - `instance` (string, required) ### 500 Invite Members Workspace Users Request Internal Server Error Internal Server Error - `any` ## Examples **Request** ```json { "inviterEmail": "pQswPC@kZCGIUBOEKCZxNQjhScp.jef", "workspaceIds": [ 8731, 1166 ], "permissions": { "viewLinkedInSenders": false, "manageLinkedInSendersSettings": false, "viewLeadLists": false, "importEditManageLeadLists": false, "viewMyNetwork": false, "viewCampaigns": false, "editManageCampaigns": false, "viewLinkedInSenderInboxes": false, "replyFromLinkedInSenderInboxes": false, "viewIntegrations": false, "manageIntegrations": false, "exportDataToCRMs": false, "viewNotifications": false, "manageNotifications": false }, "emails": [ "string", "string" ] } ``` **Response** ```json [ { "workspaces": [ { "workspaceId": 5937, "success": true, "errorCode": "Success", "errorMessage": "string" }, { "workspaceId": 2957, "success": true, "errorCode": "UnknownError", "errorMessage": "string" } ], "invitationId": 7510, "invitationStatus": "Pending", "invitationUrl": "string", "invitationExpirationTime": "2011-12-31T22:55:45Z", "emailAddress": "string" }, { "workspaces": [ { "workspaceId": 9214, "success": true, "errorCode": "UnknownError", "errorMessage": "string" }, { "workspaceId": 1177, "success": false, "errorCode": "WorkspaceDoesNotExists", "errorMessage": "string" } ], "invitationId": 8662, "invitationStatus": "Revoked", "invitationUrl": "string", "invitationExpirationTime": "1947-11-19T13:31:07Z", "emailAddress": "string" } ] ``` **SDK Code** ```python import requests url = "https://api//api/public/management/organizations/users/invite/members" payload = { "inviterEmail": "pQswPC@kZCGIUBOEKCZxNQjhScp.jef", "workspaceIds": [8731, 1166], "permissions": { "viewLinkedInSenders": False, "manageLinkedInSendersSettings": False, "viewLeadLists": False, "importEditManageLeadLists": False, "viewMyNetwork": False, "viewCampaigns": False, "editManageCampaigns": False, "viewLinkedInSenderInboxes": False, "replyFromLinkedInSenderInboxes": False, "viewIntegrations": False, "manageIntegrations": False, "exportDataToCRMs": False, "viewNotifications": False, "manageNotifications": False }, "emails": ["string", "string"] } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api//api/public/management/organizations/users/invite/members'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"inviterEmail":"pQswPC@kZCGIUBOEKCZxNQjhScp.jef","workspaceIds":[8731,1166],"permissions":{"viewLinkedInSenders":false,"manageLinkedInSendersSettings":false,"viewLeadLists":false,"importEditManageLeadLists":false,"viewMyNetwork":false,"viewCampaigns":false,"editManageCampaigns":false,"viewLinkedInSenderInboxes":false,"replyFromLinkedInSenderInboxes":false,"viewIntegrations":false,"manageIntegrations":false,"exportDataToCRMs":false,"viewNotifications":false,"manageNotifications":false},"emails":["string","string"]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api//api/public/management/organizations/users/invite/members" payload := strings.NewReader("{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api//api/public/management/organizations/users/invite/members") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api//api/public/management/organizations/users/invite/members") .header("Content-Type", "application/json") .body("{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}") .asString(); ``` ```php request('POST', 'https://api//api/public/management/organizations/users/invite/members', [ 'body' => '{ "inviterEmail": "pQswPC@kZCGIUBOEKCZxNQjhScp.jef", "workspaceIds": [ 8731, 1166 ], "permissions": { "viewLinkedInSenders": false, "manageLinkedInSendersSettings": false, "viewLeadLists": false, "importEditManageLeadLists": false, "viewMyNetwork": false, "viewCampaigns": false, "editManageCampaigns": false, "viewLinkedInSenderInboxes": false, "replyFromLinkedInSenderInboxes": false, "viewIntegrations": false, "manageIntegrations": false, "exportDataToCRMs": false, "viewNotifications": false, "manageNotifications": false }, "emails": [ "string", "string" ] }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api//api/public/management/organizations/users/invite/members"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "inviterEmail": "pQswPC@kZCGIUBOEKCZxNQjhScp.jef", "workspaceIds": [8731, 1166], "permissions": [ "viewLinkedInSenders": false, "manageLinkedInSendersSettings": false, "viewLeadLists": false, "importEditManageLeadLists": false, "viewMyNetwork": false, "viewCampaigns": false, "editManageCampaigns": false, "viewLinkedInSenderInboxes": false, "replyFromLinkedInSenderInboxes": false, "viewIntegrations": false, "manageIntegrations": false, "exportDataToCRMs": false, "viewNotifications": false, "manageNotifications": false ], "emails": ["string", "string"] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/management/organizations/users/invite/members")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```