Update Organization Info

Purpose

To update the details of the organization.

Endpoints

UPDATE /orginfo/{apiName}

Request Details

Request URL

https://contracts.zoho.com/api/v1/admin/orginfo/{apiName}

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.meta.UPDATE, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to organization info
UPDATE - Update organization info

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/admin/orginfo/abccompany"
-X UPDATE
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Input JSON Keys

namestring
Represents the name of the organization.

country, city, state, address, statestring
Represents the address details of the organization.

websitestring
Represents the website of the organization.

phoneNumberstring
Represents the phone number of the organization.

Sample Input

Copied{
    "phoneNumber": String,
    "name": String,
    "country": String (country code),
    "city": String,
    "address": String,
    "state": String,
    "webSite": String
  }

Response JSON Keys

apiNamestring
Represents the name of the organization in the API.

Sample Response

Copied{
	"Type": "Success",
	"apiName": ${zc_api}
}

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect

Resolution: Specify a valid request URL. Refer to the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized

Resolution: Client does not have contracts.meta.UPDATE scope. Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to update

Resolution: The user does not have permission to update records. Contact your organization administrator.

INTERNAL_ERRORHTTP 500

Internal Server Error

Resolution: Unexpected and unhandled exception in the server.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

The user does not have sufficient privilege to update module details.

Resolution: The user does not have permission to update module details. Contact your organization administrator.