Skip to main content

Change Portal Owner

Description

This API can be used to change the owner of the portal.

Request Payload:

  • new_owner_id - The operator id of the new portal owner.

OAuth Scope:

SalesIQ.portals.UPDATE

URL:

Copiedhttps://{zohosalesiq_server_uri}/api/v2/portals/{screen name}/owner

Example:

Copiedhttps://salesiq.zoho.com/api/v2/portals/zylker-inc/owner

Payload

Copied{
	 "new_owner_id" : "7000000000005",
}

Success Response

Copied{
	 "object" : "portal",
	"url" : "api/v2/portals/zylker-inc"
	 "data":
		 {
			"owner_id": "6000000000005",
			"name": "zylker",
 			"screenname": "zylker-inc",
			 "logo_url": "https://salesiq.zoho.com/zylkerinc/userimg/patricia-103/photo.ls"
		 }
}

Error Codes

1. Ineligible user role

This error message will be displayed either when a user of ineligible role say associate or supervisor is attempted to be be made the owner of a portal, as only a user in administrator role can be a portal owner or when the user is already a owner of an other portal. code :  1100Error Message : "Ineligible user role."

2. Invalid User id

This error message will be displayed when a user whose id could not be mapped with the user ids associated with the particular portal that he/she is trying to access.code : 1101Error Message : "Invalid user id"

3. Restricted operation

This error message will be displayed when a user who is not a portal owner and attempts to perform an operation that is restricted only to the users of portal owner role.code : 1016Error Message : "Attempting to perform a restricted operation"