POST - Add Child Organization to a Partner Portal

Purpose

This API is used to create a new child organization, along with the domain and other details, and associates it with the partner portal. Only the users having a Partner Admin role can use this API.

OAuth Scope

Use the scope

ZohoMail.partner.organization.ALL (or) ZohoMail.partner.organization.CREATE 

to generate the Authtoken.

ALL - Full access to the organization

CREATE - Create a child organization

Request URL 

Method: POST

https://mail.zoho.com/api/organization

Request Body (JSON Object)

  • domainName string, mandatory
    •  Provide the domain name of the child organization that needs to be added.
  • orgName string
    •  Provide the name of the child organization that needs to be added.
  • emailId string, mandatory
    •  Provide the email address of the super admin of the child organization.
  • firstName string, mandatory
    •  Provide the first name of the super admin of the child organization.
  • lastName string, mandatory
    •  Provide the last name of the super admin of the child organization.
  • password string, mandatory
    •  Provide the password for the super admin account of the child organization.
  • planName string
    •  Provide the enrolled plan name of the child organization.
    • The value can be basicTrial, professionalTrial, mailPremiumTrial, or free.

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copied{
    "domainName": "zylker-mail.com",
    "orgName":"zylkermail",
    "emailId":"zylkermail@zylker-mail.com",
    "firstName":"zylkermail",
    "lastName":"Z",
    "password":"zylkermail@0"
}

The above sample request adds the domain zylker-mail.com to the Partner Portal. 

Sample Response

Copied{
    "status": {
        "code": 201,
        "description": "Created"
    },
    "data": {
        "orgName": "zylkermail",
        "st_enc_zoid": "9693b309f4c9e3a5ed52e7888ba27b81",
        "isVerified": false,
        "zoid": "76006415",
        "usedLicenseCount": 1,
        "URI": "https://mail.zoho.com/api/organization/76006415",
        "encryptedZoid": "7d4b5694a64799168f94c4fb749c23bda3115a6062f5f6fbea48c022d91c0323",
        "isTrialAllowed": true,
        "domainName": "zylker-mail.com",
        "basePlan": "Mail Free",
        "zaid": "76005578",
        "superAdmin": "zylkermail@zylker-mail.com",
        "isEmailConfirmed": false,
        "isOrgLogoExist": false,
        "licenseCount": 5
    }
}