Create organization member

Creates a new organization member (external contact) for an organization. This automatically creates a user account that can be used for guest access to Leadtime.

What happens:

A new organization member record is created
A user account is automatically created and linked to the member
If canLogin is true:
- User status is set to Active
- In ready workspaces, an invitation email is sent with a secure link for setting a password
- During initial workspace setup, invitation email delivery is deferred until setup is finished
- The user can log in as a guest user
If canLogin is false or omitted:
- User status is set to Inactive
- No invitation is sent
- The member exists as a contact only

Required fields:

organizationId - The organization this member belongs to
firstName - Member’s first name
lastName - Member’s last name
email - Email address (used for user account)
roleId - User role ID (e.g., workspace-id_guest_ for guest access)

Avatar management:

avatarId is an avatar configuration ID. During the transition, an image file ID from POST /workspace/upload is also accepted and converted to an uploaded avatar configuration.

Personality classifications:

Influence level: Low, Medium, High, Dominant
Attitude level: Enthusiastic, WellMeaning, Neutral, Opposing
Personality type: Dominant, Conscientious, Steady, Initiative

Returns: The created organization member with all details including the generated user ID.

POST/organizations/members

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Query parameters

fieldsToReturnstring

Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.

responseShapestring

Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:compactfull

Header parameters

LT-Response-Shapestring

Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:full

Request body

requiredapplication/json

addressCitystring

City

addressCountrystring

Country

addressHouseNumberstring

House number

addressStreetstring

Street address

addressZipstring

ZIP/postal code

attitudeLevelstring

Attitude level classification

Allowed:EnthusiasticWellMeaningNeutralOpposing

avatarConfigobject

Generated avatar configuration. If provided, it takes precedence over avatarId.

avatarIdstring

Avatar configuration ID. During the transition, an image file ID from POST /workspace/upload is also accepted and converted to an uploaded avatar configuration. Omit to create the default generated avatar.

birthDatestring<date-time>

Birth date (ISO 8601 date format: YYYY-MM-DD)

canLoginboolean

Whether the member can log in to Leadtime as a guest user. If true, a user account is created with Active status. In ready workspaces, an invitation email is sent immediately. During initial workspace setup, invitation emails are suppressed until setup is finished. If false or omitted, the member exists as a contact only with an Inactive user account. Defaults to false.

degreestring

Academic degree

emailstringrequired

Email address of the member. This email will be used for the associated user account and for sending invitation emails if login access is enabled. Must be a valid email format.

firstNamestringrequired

First name

genderstring

Gender

Allowed:MaleFemale

influenceLevelstring

Influence level classification

Allowed:LowMediumHighDominant

isActivebooleanrequired

Whether the member is active in the system. Inactive members are hidden from normal views but remain in the database. Defaults to true.

default: true

lastNamestringrequired

Last name

organizationIdstringrequired

UUID of the organization this member belongs to. The organization must exist in your workspace.

personalityTypestring

Personality type classification

Allowed:DominantConscientiousSteadyInitiative

phonestring

Phone number

positionstring

Job title or position within the organization (e.g., "Managing Director", "Project Manager", "Head of Sales").

roleIdstringrequired

User role ID that determines the member's access permissions in Leadtime. Common roles include guest roles (e.g., workspace-id_guest_) for external users. This role is applied to the automatically created user account.

socialNetworkLinkstring

Social network profile link

titlestring

Title/salutation (e.g., Dr., Prof.)

Responses

200

addressCityobject | nullrequired

City

addressCountryobject | nullrequired

Country

addressHouseNumberobject | nullrequired

House number

addressStreetobject | nullrequired

Street address

addressZipobject | nullrequired

ZIP/postal code

attitudeLevelstring | nullrequired

Attitude level classification

Allowed:EnthusiasticWellMeaningNeutralOpposing

avatarIdobject | nullrequired

Avatar configuration ID. Use /api/avatars/public/{avatarId}.svg to render it.

avatarUrlobject | nullrequired

Public URL to the member's generated avatar. Returns null if no avatar is configured. The URL can be used directly in image tags or for display purposes.

birthDateobject | nullrequired

Date of birth in ISO 8601 date format (YYYY-MM-DD). Returns null if not set.

canLoginbooleanrequired

Whether member can login to the system

createdAtstringrequired

ISO 8601 timestamp indicating when the organization member was created.

degreeobject | nullrequired

Academic degree

emailstringrequired

Email address

firstNamestringrequired

First name

genderstring | nullrequired

Gender

Allowed:MaleFemale

idstringrequired

Organization member ID

influenceLevelstring | nullrequired

Influence level classification

Allowed:LowMediumHighDominant

isActivebooleanrequired

Whether member is active

lastNamestringrequired

Last name

organizationIdstringrequired

Organization ID

personalityTypestring | nullrequired

Personality type classification

Allowed:DominantConscientiousSteadyInitiative

phoneobject | nullrequired

Phone number

positionobject | nullrequired

Position/role in organization

roleIdobject | nullrequired

User role ID that determines the member's access permissions in Leadtime. Can be null if the member does not have login access.

socialNetworkLinkobject | nullrequired

Social network profile link

titleobject | nullrequired

Title/salutation

updatedAtstringrequired

ISO 8601 timestamp indicating when the organization member was last updated.

userIdstringrequired

Associated user ID

400

Validation errors

errorsobject

messagestring

statusCodenumber

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

fieldsToReturnqueryComma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.responseShapequeryAdvanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.LT-Response-ShapeheaderAdvanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Bodyapplication/json

Request body

Request

curl -X POST "https://leadtime.app/api/public/organizations/members" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "addressCity": "New York",
  "addressCountry": "USA",
  "addressHouseNumber": "123A",
  "addressStreet": "Main Street",
  "addressZip": "12345",
  "attitudeLevel": "Enthusiastic",
  "avatarConfig": {
    "options": {
      "seed": "Jane Doe"
    },
    "style": "initials"
  },
  "avatarId": "123e4567-e89b-12d3-a456-426614174000",
  "birthDate": "1990-01-15",
  "canLogin": true,
  "degree": "Ph.D.",
  "email": "john.doe@example.com",
  "firstName": "John",
  "gender": "Male",
  "influenceLevel": "Low",
  "isActive": true,
  "lastName": "Doe",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "personalityType": "Dominant",
  "phone": "+1234567890",
  "position": "Manager",
  "roleId": "workspace-id_guest_",
  "socialNetworkLink": "https://linkedin.com/in/johndoe",
  "title": "Dr."
}'

const response = await fetch("https://leadtime.app/api/public/organizations/members", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"addressCity\": \"New York\",\n  \"addressCountry\": \"USA\",\n  \"addressHouseNumber\": \"123A\",\n  \"addressStreet\": \"Main Street\",\n  \"addressZip\": \"12345\",\n  \"attitudeLevel\": \"Enthusiastic\",\n  \"avatarConfig\": {\n    \"options\": {\n      \"seed\": \"Jane Doe\"\n    },\n    \"style\": \"initials\"\n  },\n  \"avatarId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"birthDate\": \"1990-01-15\",\n  \"canLogin\": true,\n  \"degree\": \"Ph.D.\",\n  \"email\": \"john.doe@example.com\",\n  \"firstName\": \"John\",\n  \"gender\": \"Male\",\n  \"influenceLevel\": \"Low\",\n  \"isActive\": true,\n  \"lastName\": \"Doe\",\n  \"organizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"personalityType\": \"Dominant\",\n  \"phone\": \"+1234567890\",\n  \"position\": \"Manager\",\n  \"roleId\": \"workspace-id_guest_\",\n  \"socialNetworkLink\": \"https://linkedin.com/in/johndoe\",\n  \"title\": \"Dr.\"\n}"
});

import requests

response = requests.post(
    "https://leadtime.app/api/public/organizations/members",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"addressCity\": \"New York\",\n  \"addressCountry\": \"USA\",\n  \"addressHouseNumber\": \"123A\",\n  \"addressStreet\": \"Main Street\",\n  \"addressZip\": \"12345\",\n  \"attitudeLevel\": \"Enthusiastic\",\n  \"avatarConfig\": {\n    \"options\": {\n      \"seed\": \"Jane Doe\"\n    },\n    \"style\": \"initials\"\n  },\n  \"avatarId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"birthDate\": \"1990-01-15\",\n  \"canLogin\": true,\n  \"degree\": \"Ph.D.\",\n  \"email\": \"john.doe@example.com\",\n  \"firstName\": \"John\",\n  \"gender\": \"Male\",\n  \"influenceLevel\": \"Low\",\n  \"isActive\": true,\n  \"lastName\": \"Doe\",\n  \"organizationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"personalityType\": \"Dominant\",\n  \"phone\": \"+1234567890\",\n  \"position\": \"Manager\",\n  \"roleId\": \"workspace-id_guest_\",\n  \"socialNetworkLink\": \"https://linkedin.com/in/johndoe\",\n  \"title\": \"Dr.\"\n}",
)

Response

{
  "addressCity": "New York",
  "addressCountry": "USA",
  "addressHouseNumber": "123A",
  "addressStreet": "Main Street",
  "addressZip": "12345",
  "attitudeLevel": "Enthusiastic",
  "avatarId": "123e4567-e89b-12d3-a456-426614174000",
  "avatarUrl": "https://example.com/api/avatars/public/123e4567-e89b-12d3-a456-426614174000.svg",
  "birthDate": "1990-01-15",
  "canLogin": true,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "degree": "Ph.D.",
  "email": "john.doe@example.com",
  "firstName": "John",
  "gender": "Male",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "influenceLevel": "Low",
  "isActive": true,
  "lastName": "Doe",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "personalityType": "Dominant",
  "phone": "+1234567890",
  "position": "Manager",
  "roleId": "workspace-id_guest_",
  "socialNetworkLink": "https://linkedin.com/in/johndoe",
  "title": "Dr.",
  "updatedAt": "2024-01-20T15:45:00.000Z",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "errors": {
    "email": [
      "Email is required",
      "Email must be valid"
    ],
    "firstName": [
      "First name is required"
    ],
    "lastName": [
      "Last name is required"
    ],
    "roleId": [
      "Role ID is required"
    ]
  },
  "message": "Bad Request",
  "statusCode": 400
}