Add Member In Organization

This endpoint adds a user (admin or member) to the main organization by providing the user's name, email address, and organization role. The organization ID is required. An email invite will be sent to the user, which they can accept or decline.

HTTP Method and URL

POST {{host}}/api/v2/organization/members/add?user_type=ENTERPRISE_API

Authentication Requirements

Requires a valid authentication token. Typically, this is provided via the user-token variable in the environment.

Path and Query Parameters

• user_type (query, required): Must be set to ENTERPRISE_API.

Request Body

Content-Type: multipart/form-data

• data[0][email] (string, required): Email of the member to be added.
• 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., Member).
• data[0][organization_id] (string, required): ID of the organization.

Example Request

POST {{host}}/api/v2/organization/members/add?user_type=ENTERPRISE_API
Content-Type: multipart/form-data
Authorization: Bearer {USER-TOKEN}

Form Data:
data[0][email]: [email protected]
data[0][first_name]: Test
data[0][last_name]: Test
data[0][role]: Member
data[0][organization_id]: 4

Example Successful Response

{
  "status": "success",
  "message": "Invitation sent to user."
}

Error Responses

• 400 Bad Request: Missing or invalid parameters.
• 401 Unauthorized: Authentication failed or missing token.
• 409 Conflict: User already exists in the organization.
• 500 Internal Server Error: Unexpected server error.

Usage Notes

• The user will receive an email invitation to join the organization.
• The invitation can be accepted or declined by the user.
• Ensure the organization ID and email are correct to avoid errors.