---
updatedAt: 2026-04-21T05:36:32.000Z
agentTools:
  projectIndex: https://developer.officernd.com/llms.txt
---

# Add new member

Add new member 

 Required scopes: `flex.community.members.create`

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v2/organizations/{orgSlug}/members": {
      "post": {
        "description": "Add new member \n\n Required scopes: `flex.community.members.create`",
        "operationId": "MembersController_addItem_api/v2",
        "parameters": [
          {
            "name": "orgSlug",
            "required": true,
            "in": "path",
            "description": "organization slug",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddMemberDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MemberResultDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "oauth2": [
              "flex.community.members.create"
            ]
          }
        ],
        "summary": "Add new member",
        "tags": [
          "Members"
        ]
      }
    }
  },
  "info": {
    "title": "Community API",
    "description": "",
    "version": "2.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://app.officernd.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          },
          "authorizationCode": {
            "authorizationUrl": "https://identity.officernd.com/auth/authorize",
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          }
        }
      }
    },
    "schemas": {
      "MemberCalculatedStatus": {
        "type": "string",
        "enum": [
          "active",
          "former",
          "pending",
          "contact",
          "not_approved",
          "drop-in",
          "lead"
        ],
        "description": "The status of the member."
      },
      "AddressResultDto": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "description": "The country of the address.",
            "example": "United States"
          },
          "state": {
            "type": "string",
            "description": "The state of the address.",
            "example": "California"
          },
          "city": {
            "type": "string",
            "description": "The city of the address.",
            "example": "San Francisco"
          },
          "street": {
            "type": "string",
            "description": "The street of the address.",
            "example": "123 Main St"
          },
          "zip": {
            "type": "string",
            "description": "The zip of the address.",
            "example": "94105"
          }
        }
      },
      "MemberBillingDetailsResultDto": {
        "type": "object",
        "properties": {
          "billingName": {
            "type": "string",
            "description": "The billing name of the member that will appear on transactions and invoices.",
            "example": "John Doe"
          },
          "vatNumber": {
            "type": "string",
            "description": "The VAT number of the member.",
            "example": "123456789"
          },
          "registrationNumber": {
            "type": "string",
            "description": "The registration number of the member.",
            "example": "987654321"
          },
          "paymentMethod": {
            "type": "string",
            "description": "The payment method of the member.",
            "example": "Cash"
          },
          "taxRate": {
            "type": "string",
            "description": "A reference to the tax rate that will be applied to the member.",
            "example": "6780f1ba1e2f3a4b5c6d7e8f"
          },
          "shouldSendOverdueReminders": {
            "type": "boolean",
            "description": "Whether overdue invoice reminders should be sent for this member.",
            "example": true
          },
          "date": {
            "type": "number",
            "description": "Day of month (1–31) for the billing cycle.",
            "example": 15,
            "minimum": 1,
            "maximum": 31
          },
          "billingAddress": {
            "description": "The billing address of the member.",
            "example": {
              "country": "United States",
              "state": "California",
              "city": "San Francisco",
              "street": "123 Main St, San Francisco, CA 94105",
              "zip": "94105"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/AddressResultDto"
              }
            ]
          }
        }
      },
      "PortalPrivacyResultDto": {
        "type": "object",
        "properties": {
          "isVisible": {
            "type": "boolean",
            "description": "Determines whether the member's profile is visible in the members portal.",
            "example": true
          },
          "showContactDetails": {
            "type": "boolean",
            "description": "Determines whether the member's contact details are visible in the members portal.",
            "example": true
          },
          "showSocialProfiles": {
            "type": "boolean",
            "description": "Determines whether the member's (Twitter, LinkedIn, Facebook, Instragram) socials are visible in the members portal.",
            "example": true
          }
        }
      },
      "SocialProfilesResultDto": {
        "type": "object",
        "properties": {
          "linkedin": {
            "type": "string",
            "description": "LinkedIn profile URL or handle",
            "example": "https://linkedin.com/in/johndoe"
          },
          "twitter": {
            "type": "string",
            "description": "Twitter/X profile URL or handle",
            "example": "https://twitter.com/johndoe"
          },
          "instagram": {
            "type": "string",
            "description": "Instagram profile URL or handle",
            "example": "https://instagram.com/johndoe"
          },
          "facebook": {
            "type": "string",
            "description": "Facebook profile URL",
            "example": "https://facebook.com/johndoe"
          }
        }
      },
      "MemberResultDto": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "object",
            "description": "An object that contains all custom properties that can be applied to the item.",
            "example": {
              "customProperty1": "value1",
              "customProperty2": "value2"
            }
          },
          "_id": {
            "type": "string",
            "description": "The unique identifier of the member.",
            "example": "603dfbc260f4054084125d33"
          },
          "name": {
            "type": "string",
            "description": "The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match.",
            "example": "John Doe"
          },
          "email": {
            "type": "string",
            "description": "The email of the member.",
            "example": "john.doe@example.com"
          },
          "phone": {
            "type": "string",
            "description": "The primary phone number of the member.",
            "example": "012-345-6789"
          },
          "image": {
            "type": "string",
            "description": "The logo/image URL of the member.",
            "example": "image-url.com"
          },
          "description": {
            "type": "string",
            "description": "The description/bio of the member.",
            "example": "John Doe is an example member of the organization."
          },
          "location": {
            "type": "string",
            "description": "Reference to the location of the member.",
            "example": "603dfbc260f4054084125d33"
          },
          "company": {
            "type": "string",
            "description": "Reference to the company the member belongs to.",
            "example": "603dfbc260f4054084125d33"
          },
          "status": {
            "description": "The status of the member.",
            "example": "active",
            "allOf": [
              {
                "$ref": "#/components/schemas/MemberCalculatedStatus"
              }
            ]
          },
          "startDate": {
            "format": "date-time",
            "type": "string",
            "description": "The starting date of the member.",
            "example": "2025-01-01T00:00:00.000Z"
          },
          "isBillingPerson": {
            "type": "boolean",
            "description": "True if the member is the billing person of his company and receives all the invoices.",
            "example": true
          },
          "isContactPerson": {
            "type": "boolean",
            "description": "True if the member is a contact person in his company.",
            "example": true
          },
          "address": {
            "description": "The address details of the member.",
            "example": {
              "country": "United States",
              "state": "California",
              "city": "San Francisco",
              "street": "123 Main St, San Francisco, CA 94105",
              "zip": "94105"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/AddressResultDto"
              }
            ]
          },
          "billingDetails": {
            "description": "The billing details of the member.",
            "example": {
              "billingName": "Example Billing Name",
              "vatNumber": "123456789",
              "registrationNumber": "987654321",
              "paymentMethod": "Cash",
              "date": 15,
              "shouldSendOverdueReminders": true,
              "billingAddress": {
                "country": "United States",
                "state": "California",
                "city": "San Francisco",
                "street": "123 Main St, San Francisco, CA 94105",
                "zip": "94105"
              }
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/MemberBillingDetailsResultDto"
              }
            ]
          },
          "portalPrivacy": {
            "description": "The portal privacy settings of the member.",
            "example": {
              "isVisible": true,
              "showContactDetails": false,
              "showSocialProfiles": true
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/PortalPrivacyResultDto"
              }
            ]
          },
          "socialProfiles": {
            "description": "Social media profiles of the member.",
            "example": {
              "linkedin": "https://linkedin.com/in/johndoe",
              "twitter": "https://twitter.com/johndoe",
              "instagram": "https://instagram.com/johndoe",
              "facebook": "https://facebook.com/johndoe"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/SocialProfilesResultDto"
              }
            ]
          },
          "createdAt": {
            "format": "date-time",
            "type": "string",
            "description": "The date of creation of the member. It may be different from the start date.",
            "example": "2025-01-01T00:00:00.000Z"
          },
          "createdBy": {
            "type": "string",
            "description": "The user that created the member.",
            "example": "603dfbc260f4054084125d33"
          },
          "modifiedAt": {
            "format": "date-time",
            "type": "string",
            "description": "The date of the last update of the member.",
            "example": "2025-01-01T00:00:00.000Z"
          },
          "modifiedBy": {
            "type": "string",
            "description": "The user that did the last modification to the member. If no update is made this field will match the \"createdBy\" field.",
            "example": "603dfbc260f4054084125d33"
          },
          "tags": {
            "description": "An array of tags associated with the member.",
            "example": [
              "vip",
              "early-adopter"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "AddressRequestDto": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "description": "The country of the address.",
            "example": "United States"
          },
          "state": {
            "type": "string",
            "description": "The state of the address.",
            "example": "California"
          },
          "city": {
            "type": "string",
            "description": "The city of the address.",
            "example": "San Francisco"
          },
          "street": {
            "type": "string",
            "description": "The street of the address.",
            "example": "123 Main St"
          },
          "zip": {
            "type": "string",
            "description": "The zip of the address.",
            "example": "94105"
          }
        }
      },
      "MemberBillingDetailsRequestDto": {
        "type": "object",
        "properties": {
          "billingName": {
            "type": "string",
            "description": "The billing name of the member that will appear on transactions and invoices.",
            "example": "OfficeRnD"
          },
          "vatNumber": {
            "type": "string",
            "description": "The VAT number of the member.",
            "example": "123456789"
          },
          "registrationNumber": {
            "type": "string",
            "description": "The registration number of the member.",
            "example": "987654321"
          },
          "paymentMethod": {
            "type": "string",
            "description": "The payment method of the member.",
            "example": "Cash"
          },
          "shouldSendOverdueReminders": {
            "type": "boolean",
            "description": "Whether overdue invoice reminders should be sent for this member.",
            "example": true
          },
          "date": {
            "type": "number",
            "description": "Day of month (1–31) for the billing cycle.",
            "example": 15,
            "minimum": 1,
            "maximum": 31
          },
          "billingAddress": {
            "description": "The billing address of the member.",
            "example": {
              "country": "United States",
              "state": "California",
              "city": "San Francisco",
              "street": "123 Main St, San Francisco, CA 94105",
              "zip": "94105"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/AddressRequestDto"
              }
            ]
          }
        }
      },
      "PortalPrivacyRequestDto": {
        "type": "object",
        "properties": {
          "isVisible": {
            "type": "boolean",
            "description": "Determines whether the member's profile is visible in the members portal.",
            "example": true
          },
          "showContactDetails": {
            "type": "boolean",
            "description": "Determines whether the member's contact details are visible in the members portal.",
            "example": true
          },
          "showSocialProfiles": {
            "type": "boolean",
            "description": "Determines whether the member's (Twitter, LinkedIn, Facebook, Instragram) socials are visible in the members portal.",
            "example": true
          }
        }
      },
      "SocialProfilesRequestDto": {
        "type": "object",
        "properties": {
          "linkedin": {
            "type": "string",
            "description": "LinkedIn profile URL or handle",
            "example": "https://linkedin.com/in/johndoe"
          },
          "twitter": {
            "type": "string",
            "description": "Twitter/X profile URL or handle",
            "example": "https://twitter.com/johndoe"
          },
          "instagram": {
            "type": "string",
            "description": "Instagram profile URL or handle",
            "example": "https://instagram.com/johndoe"
          },
          "facebook": {
            "type": "string",
            "description": "Facebook profile URL",
            "example": "https://facebook.com/johndoe"
          }
        }
      },
      "AddMemberDto": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "object",
            "description": "An object that contains all custom properties that can be applied to the item.",
            "example": {
              "customProperty1": "value1",
              "customProperty2": "value2"
            }
          },
          "name": {
            "type": "string",
            "description": "The name of the member.",
            "example": "John Doe"
          },
          "location": {
            "type": "string",
            "description": "Reference to the location of the member.",
            "example": "603dfbc260f4054084125d33"
          },
          "startDate": {
            "format": "date-time",
            "type": "string",
            "description": "The starting date of the member.",
            "example": "2025-01-01T00:00:00.000Z"
          },
          "email": {
            "type": "string",
            "description": "The email the member will be associated with.",
            "example": "john.doe@example.com"
          },
          "phone": {
            "type": "string",
            "description": "The primary phone number of the member.",
            "example": "012-345-6789"
          },
          "image": {
            "type": "string",
            "description": "The logo/image URL of the member.",
            "example": "image-url.com"
          },
          "company": {
            "type": "string",
            "description": "Reference to the company the member belongs to. If not provided, the member will not be associated with a company.",
            "example": "603dfbc260f4054084125d33"
          },
          "description": {
            "type": "string",
            "description": "The description/bio of the member.",
            "example": "John Doe is an example member of the organization."
          },
          "isBillingPerson": {
            "type": "boolean",
            "description": "True if the member is the billing person of his company and receives all the invoices.",
            "example": true
          },
          "isContactPerson": {
            "type": "boolean",
            "description": "True if the member is a contact person in his company.",
            "example": true
          },
          "address": {
            "description": "The address of the member.",
            "example": {
              "country": "United States",
              "state": "California",
              "city": "San Francisco",
              "street": "123 Main St, San Francisco, CA 94105",
              "zip": "94105"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/AddressRequestDto"
              }
            ]
          },
          "billingDetails": {
            "description": "The billing details of the member.",
            "example": {
              "billingName": "Example Billing Name",
              "vatNumber": "123456789",
              "registrationNumber": "987654321",
              "paymentMethod": "Cash",
              "date": 15,
              "shouldSendOverdueReminders": true,
              "billingAddress": {
                "country": "United States",
                "state": "California",
                "city": "San Francisco",
                "street": "123 Main St, San Francisco, CA 94105",
                "zip": "94105"
              }
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/MemberBillingDetailsRequestDto"
              }
            ]
          },
          "portalPrivacy": {
            "description": "The portal privacy settings of the member.",
            "example": {
              "isVisible": true,
              "showContactDetails": false,
              "showSocialProfiles": true
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/PortalPrivacyRequestDto"
              }
            ]
          },
          "socialProfiles": {
            "description": "Social media profiles of the member.",
            "example": {
              "linkedin": "https://linkedin.com/in/johndoe",
              "twitter": "https://twitter.com/johndoe",
              "instagram": "https://instagram.com/johndoe",
              "facebook": "https://facebook.com/johndoe"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/SocialProfilesRequestDto"
              }
            ]
          },
          "tags": {
            "description": "An array of tags associated with the member.",
            "example": [
              "vip",
              "early-adopter"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "location",
          "startDate"
        ]
      }
    }
  }
}
```