Auto-Join Member In Organization

This endpoint allows you to automatically add new users to a specific organization under the specified user type. No email invitation is sent; the user will have the 'Joined' status immediately. You must provide the user's name, email, organization role, and organization ID.

HTTP Method and URL

• Method: POST
• URL: {{host}}/api/v2/organization/members/auto-join?user_type=ENTERPRISE_API

Authentication Requirements

• Requires valid authentication (e.g., Bearer token in the Authorization header).

Path and Query Parameters

• user_type (query parameter, required): Specifies the type of user to be added. Example: ENTERPRISE_API.

Request Body

Content-Type: multipart/form-data

• data[0][email] (string, required): Email address of the member to add.
• data[0][first_name] (string, required): First name of the member.
• data[0][last_name] (string, required): Last name of the member.
• data[0][role] (string, required): Role of the member (e.g., Admin).
• data[0][organization_id] (string, required): Organization ID to which the member will be added.

Example Request

POST {{host}}/api/v2/organization/members/auto-join?user_type=ENTERPRISE_API
Content-Type: multipart/form-data
Authorization: Bearer <token>

Form Data:
data[0][email]: [email protected]
data[0][first_name]: Test
data[0][last_name]: Test
data[0][role]: Admin
data[0][organization_id]: 1046

Example Successful Response

{
  "status": "success",
  "message": "User added and joined organization successfully."
}

Error Responses

• 400 Bad Request: Missing or invalid parameters.
• 401 Unauthorized: Authentication failed or missing.
• 403 Forbidden: Insufficient permissions.
• 409 Conflict: User already exists in the organization.

Usage Notes

• The user will be added with 'Joined' status and will not receive an invitation email.
• Ensure all required fields are provided in the form-data body.