Zum Inhalt springen
Leadtime
Deutsch
EnglishDeutschNicht übersetzt
Esc
↑↓navigate↵open⌘Jpreview

Update organization member

Partially updates an existing organization member. Only the fields you provide will be updated; all other fields remain unchanged.

Automatic user synchronization: Changes to certain fields automatically sync to the associated user account:

  • firstName → Updates user’s first name
  • lastName → Updates user’s last name
  • email → Updates user’s email address
  • roleId → Updates user’s role
  • canLogin → Controls user access and status

Login access changes:

  • Enabling login (canLogin: false → true):
    • User status changes to Active
    • In ready workspaces, an invitation email is sent with a magic link
    • During initial workspace setup, invitation email delivery is deferred until setup is finished
    • User can now log in as a guest user
  • Disabling login (canLogin: true → false):
    • User status changes to Inactive
    • Invite token is cleared
    • User can no longer log in

Avatar management:

  • To update avatar: provide an avatar configuration ID. During the transition, an uploaded image file ID is also accepted.
  • To remove avatar: Set avatarId to null or an empty string

All other fields (address, phone, personality traits, etc.) can be updated independently without affecting the user account.

PATCH/organizations/members/{id}
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
idstringrequired
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 for the member's address. Part of the complete address information.
addressCountrystring
Country for the member's address. Part of the complete address information.
addressHouseNumberstring
House or building number for the member's address. Part of the complete address information.
addressStreetstring
Street name for the member's address. Part of the complete address information.
addressZipstring
ZIP or postal code for the member's address. Part of the complete address information.
attitudeLevelstring
Classification of the member's attitude towards your company. Used for relationship management and communication strategy. Available values: `Enthusiastic`, `WellMeaning`, `Neutral`, `Opposing`.
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. To remove: set to `null` or empty string. If not provided, the avatar remains unchanged.
birthDatestring<date-time>
Date of birth in ISO 8601 date format (YYYY-MM-DD). Used for birthday reminders and age calculations.
canLoginboolean
Whether the member can log in to Leadtime. Changing this value will update the associated user account: setting to `true` activates the user. In ready workspaces, an invitation email is sent automatically. During initial workspace setup, invitation emails are suppressed until setup is finished. Setting to `false` deactivates the user and clears the invite token.
degreestring
Academic degree or qualification (e.g., "Ph.D.", "MBA", "M.Sc."). Used in formal communications.
emailstring
Email address. If provided, this change will automatically sync to the associated user account. Must be a valid email format.
firstNamestring
First name. If provided, this change will automatically sync to the associated user account.
genderstring
Gender of the member. Used for personalized greetings in letters and communications. Available values: `Male`, `Female`.
Allowed:MaleFemale
influenceLevelstring
Classification of the member's level of influence within their organization. Used for relationship management and strategic planning. Available values: `Low`, `Medium`, `High`, `Dominant`.
Allowed:LowMediumHighDominant
isActiveboolean
Whether the member is active in the system. Inactive members are hidden from normal views but remain in the database.
lastNamestring
Last name. If provided, this change will automatically sync to the associated user account.
personalityTypestring
Personality type classification based on behavioral patterns. Used for tailoring communication and interaction approaches. Available values: `Dominant`, `Conscientious`, `Steady`, `Initiative`.
Allowed:DominantConscientiousSteadyInitiative
phonestring
Phone number for contacting the member. Can include country code prefix (e.g., +1 for US).
positionstring
Job title or position within the organization (e.g., "Managing Director", "Project Manager", "Head of Sales").
roleIdstring
User role ID that determines access permissions. If provided, this change will automatically sync to the associated user account, updating their permissions in Leadtime.
socialNetworkLinkstring
URL to a social network profile (e.g., LinkedIn, Twitter, XING). Used for relationship management and contact information.
titlestring
Title or salutation prefix (e.g., "Dr.", "Prof.", "Mr.", "Mrs."). Used in formal communications and letters.
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
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X PATCH "https://leadtime.app/api/public/organizations/members/string" \
  -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",
  "personalityType": "Dominant",
  "phone": "+1234567890",
  "position": "Senior Manager",
  "roleId": "workspace-id_staff_",
  "socialNetworkLink": "https://linkedin.com/in/johndoe",
  "title": "Dr."
}'
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"
}