Skip to content

create_member.mdx

Latest commit

 

History

History
103 lines (83 loc) · 2.76 KB

create_member.mdx

File metadata and controls

103 lines (83 loc) · 2.76 KB
Raw
title Companies API: Create member
description Reference for the create member mutation in the Companies API.

import CurlExampleBlock from "@components/CurlExampleBlock.jsx"

Endpoint

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

Authentication

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

Inputs

</tbody>
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 Yes No
new_account boolean Yes No
person_id string No Yes

cURL Example

<CurlExampleBlock client:load command={"curl --request POST \\n --url "https://app.operately.com/api/external/v1/companies/create_member\" \\n --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \\n --header "Content-Type: application/json" \\n --data '{"email":"value", "full_name":"value", "title":"value"}'"} />

Response Example

{
  "invite_link": {
    "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"
}