Add a New User to an Existing Organization

Description

This API enables you to add a new end-user to an existing organization without creating a new organization for them. This can be done by providing the ZAAID of the organization that the user must be added to. The organization of a user cannot be changed later, once it is associated with their account.

When the user has signed up, unique identification values such as ZUID and User ID are created for them.

Request URL

https://api.catalyst.zoho.com/baas/v1/project/{project_id}/project-user

project_id - The unique ID of the project

Request Headers

Authorization: Zoho-oauthtoken 1000.910***************************16.2f****************************57
Content-Type: application/json

Request Method

POST

Scope

scope=ZohoCatalyst.projects.users.CREATE

Request JSON Properties

Attributes

Data Type

Mandatory

Max Size

Description

ZAID

String

100

Unique identifier that maps an application to a project

user_detailsShow properties

JSON

Yes

The JSON that contains the details of the user

user_details Properties

Attribute	Data Type	Mandatory	Max Size	Description
first_name	String	No	100	First name of the user
last_name	String	Yes	100	Last name of the user
email_id	String	Yes	N/A	Email address of the user
ZAAID	String	Yes	N/A	Unique identification of the organization that the user belongs to

platform_type

String

Yes

N/A

Accepted values: web, android, ios

redirect_url

String

200

The URL to be redirected to, after the user signs up for the application

SDK Documentation

Add New User to Existing Org- Java SDK

Add New User to Existing Org- Node.js SDK

Curl

Sample Request


				curl -X POST \
  https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user \
  -H "Authorization: Zoho-oauthtoken 1000.910***************************16.2f****************************57"
  -H "Content-Type: application/json" \
  -d '{
	"user_details":{
                "first_name":"John",
		"last_name":"Winchester",
		"email_id":"john.w@zylker.com",
		"zaaid":4567899
	},
        "redirect_url": "https://logistics.zylker.com/app/index.html"
	"platform_type":"web"
}'

Sample Response


				{
    "status": "success",
    "data": {
        "zaid": 1011481670,
        "user_details": {
            "user_id": 671930400,
            "zuid": 3000000006001,
            "zaaid": 1011520995,
            "status": "ACTIVE",
            "is_confirmed": true,
            "email_id": "john.w@zylker.com",
            "first_name": "John",
            "last_name": "Winchester",
            "created_time": "May 13, 2019 09:16 PM",
            "modified_time": "May 13, 2019 09:16 PM",
            "invited_time": "May 13, 2019 09:16 PM",
            "role_id": 3000000005015
        },
        "redirect_url": "https://logistics.zylker.com/app/index.html",
        "platform_type": "web",
        "org_id": 1011520995
    }
}