InviteMembers | HeyReach API Documentation

curl -X POST https://api/api/public/management/organizations/users/invite/members \
     -H "Content-Type: application/json" \
     -d '{
  "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"
  ]
}'

[
  {
    "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"
  }
]

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.

Request

This endpoint expects an object.

inviterEmailstringRequiredformat: "email"

workspaceIdslist of integersRequired

permissionsobjectRequired

emailslist of stringsRequired

Response

workspaceslist of objects

invitationIdinteger

invitationStatusstring

invitationUrlstring

invitationExpirationTimedatetime

emailAddressstring

Errors

400

Invite Members Workspace Users Request Bad Request Error

401

Invite Members Workspace Users Request Unauthorized Error

429

Invite Members Workspace Users Request Too Many Requests Error

500

Invite Members Workspace Users Request Internal Server Error

Headers

Request

Response

Errors