InviteManagers | HeyReach API Documentation

curl -X POST https://api/api/public/management/organizations/users/invite/managers \
     -H "Content-Type: application/json" \
     -d '{
  "inviterEmail": "nzLa4CYTiLt@yXST.ltrp",
  "emails": [
    "string",
    "string"
  ],
  "workspaceIds": [
    6519,
    3651
  ]
}'

[
  {
    "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 as managers in your organization. Manager users are special kind of users that exist outside your organization and are invited to specific workspaces. These users will not be part of you organization and only have access to the specified workspaces. These users are automatically added to your workspace and don't need to register.

Request

This endpoint expects an object.

inviterEmailstringRequiredformat: "email"

emailslist of stringsRequired

workspaceIdslist of integersRequired

Response

workspaceslist of objects

invitationIdinteger

invitationStatusstring

invitationUrlstring

invitationExpirationTimedatetime

emailAddressstring

Errors

400

Invite Managers Workspace Users Request Bad Request Error

401

Invite Managers Workspace Users Request Unauthorized Error

429

Invite Managers Workspace Users Request Too Many Requests Error

500

Invite Managers Workspace Users Request Internal Server Error

Headers

Request

Response

Errors