Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Members

Add new member

Add new member

Required scopes: flex.community.members.create

post/api/v2/organizations/{orgSlug}/members

Path parameters

orgSlugstring required

organization slug

Request body

propertiesobject

An object that contains all custom properties that can be applied to the item.

namestring required

The name of the member.

locationstring required

Reference to the location of the member.

startDatestring date-time required

The starting date of the member.

emailstring

The email the member will be associated with.

phonestring

The primary phone number of the member.

imagestring

The logo/image URL of the member.

companystring

Reference to the company the member belongs to. If not provided, the member will not be associated with a company.

descriptionstring

The description/bio of the member.

isBillingPersonboolean

True if the member is the billing person of his company and receives all the invoices.

isContactPersonboolean

True if the member is a contact person in his company.

Example request

{
  "properties": {
    "customProperty1": "value1",
    "customProperty2": "value2"
  },
  "name": "John Doe",
  "location": "603dfbc260f4054084125d33",
  "startDate": "2025-01-01T00:00:00.000Z",
  "email": "john.doe@example.com",
  "phone": "012-345-6789",
  "image": "image-url.com",
  "company": "603dfbc260f4054084125d33",
  "description": "John Doe is an example member of the organization.",
  "isBillingPerson": true,
  "isContactPerson": true,
  "address": {
    "country": "United States",
    "state": "California",
    "city": "San Francisco",
    "street": "123 Main St",
    "zip": "94105"
  },
  "billingDetails": {
    "billingName": "OfficeRnD",
    "vatNumber": "123456789",
    "registrationNumber": "987654321",
    "paymentMethod": "Cash",
    "shouldSendOverdueReminders": true,
    "date": 15,
    "billingAddress": {
      "country": "United States",
      "state": "California",
      "city": "San Francisco",
      "street": "123 Main St",
      "zip": "94105"
    }
  },
  "portalPrivacy": {
    "isVisible": true,
    "showContactDetails": true,
    "showSocialProfiles": true
  },
  "socialProfiles": {
    "linkedin": "https://linkedin.com/in/johndoe",
    "twitter": "https://twitter.com/johndoe",
    "instagram": "https://instagram.com/johndoe",
    "facebook": "https://facebook.com/johndoe"
  }
}

Response

propertiesobject

An object that contains all custom properties that can be applied to the item.

_idstring

The unique identifier of the member.

namestring

The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match.

emailstring

The email of the member.

phonestring

The primary phone number of the member.

imagestring

The logo/image URL of the member.

descriptionstring

The description/bio of the member.

locationstring

Reference to the location of the member.

companystring

Reference to the company the member belongs to.

status'active' | 'former' | 'pending' | 'contact' | 'not_approved' | 'drop-in' | 'lead'

The status of the member.

startDatestring date-time

The starting date of the member.

isBillingPersonboolean

True if the member is the billing person of his company and receives all the invoices.

isContactPersonboolean

True if the member is a contact person in his company.

createdAtstring date-time

The date of creation of the member. It may be different from the start date.

createdBystring

The user that created the member.

modifiedAtstring date-time

The date of the last update of the member.

modifiedBystring

The user that did the last modification to the member. If no update is made this field will match the "createdBy" field.

tagsstring[]

An array of tags associated with the member.

Example response

{
  "properties": {
    "customProperty1": "value1",
    "customProperty2": "value2"
  },
  "_id": "603dfbc260f4054084125d33",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "012-345-6789",
  "image": "image-url.com",
  "description": "John Doe is an example member of the organization.",
  "location": "603dfbc260f4054084125d33",
  "company": "603dfbc260f4054084125d33",
  "startDate": "2025-01-01T00:00:00.000Z",
  "isBillingPerson": true,
  "isContactPerson": true,
  "address": {
    "country": "United States",
    "state": "California",
    "city": "San Francisco",
    "street": "123 Main St",
    "zip": "94105"
  },
  "billingDetails": {
    "billingName": "John Doe",
    "vatNumber": "123456789",
    "registrationNumber": "987654321",
    "paymentMethod": "Cash",
    "taxRate": "6780f1ba1e2f3a4b5c6d7e8f",
    "shouldSendOverdueReminders": true,
    "date": 15,
    "billingAddress": {
      "country": "United States",
      "state": "California",
      "city": "San Francisco",
      "street": "123 Main St",
      "zip": "94105"
    }
  },
  "portalPrivacy": {
    "isVisible": true,
    "showContactDetails": true,
    "showSocialProfiles": true
  },
  "socialProfiles": {
    "linkedin": "https://linkedin.com/in/johndoe",
    "twitter": "https://twitter.com/johndoe",
    "instagram": "https://instagram.com/johndoe",
    "facebook": "https://facebook.com/johndoe"
  },
  "createdAt": "2025-01-01T00:00:00.000Z",
  "createdBy": "603dfbc260f4054084125d33",
  "modifiedAt": "2025-01-01T00:00:00.000Z",
  "modifiedBy": "603dfbc260f4054084125d33",
  "tags": [
    "vip",
    "early-adopter"
  ]
}