Add New Users to Community

📨 Add Users to Community

Allows community owners to register external users into the platform with defined roles and optional plans.

HTTP Method

POST

Endpoint

/api/v1/admin/community/addExternalUsers

Headers

Name	Type	Required	Description
x-api-key	String	✅ Yes	API key provided by the Networked Team.

Body Parameters

Name	Type	Required	Description
email	String	✅ Yes	Email of the user to register.
name	String	✅ Yes	Name of the user.
password	String	❌ No	Password to set if using the Direct Add method (method = 2).
roleId	String	✅ Yes	Role to assign to the user (Admin, Moderator, Member, etc.).
planId	String	❌ No	ID of the plan to associate the user with (if applicable).
method	Number	✅ Yes	Indicates how the user is added to the community (1 = Invite, 2 = Direct).

Method Enum Values

Value	Description
1	An invite is sent to the user’s email.
2	Directly adds the user to the community with an optional password + An email with credentials is sent to the added User.

Sample Response (method = 2)

{
  "error": false,
  "message": "Operation completed successfully"
}

Sample Response (method = 1)

{
  "data": {
    "email": "example3@yopmail.com",
    "inviteId": "68874e4e81110b2a6ca6b54a",
    "timeStamp": 1753697870638
  },
  "error": false,
  "message": "Operation completed successfully"
}

Response Interface (method = 2)

interface RegisterExternalUserResponse {
  error: boolean;
  message: string;
}

Response Interface (method = 1)

interface RegisterExternalUserInviteResponse {
  data: {
    email: string;
    inviteId: string;
    timeStamp: number;
  };
  error: boolean;
  message: string;
}

Response Field Descriptions

Field	Type	Description
error	Boolean	Indicates if the operation was successful or failed.
message	String	Descriptive message for the API outcome.
data.email	String	Email to which the invite was sent (only in method = 1).
data.inviteId	String	Unique ID representing the invite created.
data.timeStamp	Number	Timestamp when the invite was generated.

Reference

🔗 Standard Response Codes

Notes

This API must be used with a valid x-api-key authorized for community owner operations.

If planId is not applicable, you may skip it or pass it as undefined.

The method field governs how the user is treated post-registration.

Use method = 2 with caution, especially if setting a default password.

📨 Add Users to Community

HTTP Method

Endpoint

Headers

Body Parameters

Method Enum Values

Sample Response (method = 2)

Sample Response (method = 1)

Response Interface (method = 2)

Response Interface (method = 1)

Response Field Descriptions

Reference

Notes

Request

Responses

Add New Users to Community

📨 Add Users to Community#

HTTP Method#

Endpoint#

Headers#

Body Parameters#

Method Enum Values#

Sample Response (method = 2)#

Sample Response (method = 1)#

Response Interface (method = 2)#

Response Interface (method = 1)#

Response Field Descriptions#

Reference#

Notes#

Request

Responses

📨 Add Users to Community

HTTP Method

Endpoint

Headers

Body Parameters

Method Enum Values

Sample Response (method = 2)

Sample Response (method = 1)

Response Interface (method = 2)

Response Interface (method = 1)

Response Field Descriptions

Reference

Notes