Companies API: Invite guest

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/companies/invite_guest
Handler	OperatelyWeb.Api.Companies.InviteGuest

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
full_name	string	Yes	No	-
email	string	Yes	No	-
title	string	Yes	No	-

Outputs#

Field	Type	Required	Nullable
invite_link	invite_link object	No	Yes
new_account	boolean	Yes	No
person_id	string	No	Yes

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/companies/invite_guest" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"email":"value", "full_name":"value", "title":"value"}'

Response Example#

{
  "invite_link": {
    "__typename": "value",
    "allowed_domains": [
      "value"
    ],
    "author": "<person>",
    "company": "<company>",
    "company_id": "value",
    "expires_at": "2026-01-01T09:30:00Z",
    "id": "value",
    "inserted_at": "2026-01-01T09:30:00Z",
    "is_active": true,
    "token": "value",
    "type": "value",
    "use_count": 123
  },
  "new_account": true,
  "person_id": "value"
}