Help Center/ Meeting/ Server API Reference/ Enterprise Management/ APIs/ Modifying an Enterprise as an SP Administrator

Updated on 2023-12-22 GMT+08:00

Online Debugging

CLI Examples

View PDF

Modifying an Enterprise as an SP Administrator

Description

This API is used to modify an enterprise. If a parameter is null or is not carried, the parameter is not modified.

Debugging

You can debug this API in API Explorer.

Prototype

**Table 1** Prototype
Request Method	PUT
Request Address	/v1/usg/dcs/sp/corp/{id}
Transport Protocol	HTTPS

Request Parameters

**Table 2** Parameters
Parameter	Mandatory	Type	Location	Description
id	Yes	String	Path	Enterprise ID.
X-Access-Token	Yes	String	Header	Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.
X-Request-Id	No	String	Header	Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.
Accept-Language	No	String	Header	Language. Values: zh-CN for Chinese (default) and en-US for English.
adminInfo	No	ModAdminDTO object	Body	Administrator details to modify.
basicInfo	No	ModCorpBasicDTO object	Body	Basic details about the enterprise to be modified.
groupId	No	String	Body	Media ingestion (including SBC and MCU) group ID, which can be obtained through the API for Querying Resource Information as an SP Administrator.
propertyInfo	No	Array of OrgPropertyDTO objects	Body	Information about configurable items.

**Table 3** ModAdminDTO data structure
Parameter	Mandatory	Type	Location	Description
country	No	String	Body	Country or region that the mobile number belongs to. If the mobile number belongs to Chinese mainland, set this parameter to chinaPR. For details, see List of countries or regions that mobile numbers belong to.
email	No	String	Body	Email address.
name	No	String	Body	Administrator name.
phone	No	String	Body	Mobile number. The mobile number must contain the country or region code, for example, +86xxxxxxxx for a mobile number in Chinese mainland. The country parameter is mandatory when you enter the mobile number.

**Table 4** ModCorpBasicDTO data structure
Parameter	Mandatory	Type	Location	Description
address	No	String	Body	Address.
country	No	String	Body	Country or region that the mobile number belongs to.
description	No	String	Body	Remarks.
email	No	String	Body	Email address, in the format of (^$\|^[\w-+]+(.[\w-+]+)@[\w-]+(.[\w-]+)(.[\w-]{1,})$).
fax	No	String	Body	Fax number, in the format of ^$\|^[+]?[0-9]+$.
name	No	String	Body	Enterprise name, in the format of ^[^#%&'+;<>="'??\....../]*$.
phone	No	String	Body	Mobile number. The mobile number must contain the country code, for example, a mobile number in Chinese mainland is +86xxxxxxxx. This parameter is combined with the country parameter. The mobile number is in the format of (^$\|^[+]?[0-9]+$).

Status Codes

**Table 5** Status codes
HTTP Status Code	Description
200	Operation successful.
400	Invalid parameters.
401	Authentication is not performed or fails.
403	Insufficient permissions.
500	Server exception.

Response Parameters

None

Example Request

PUT /v1/usg/dcs/sp/corp/818803911
Connection: keep-alive
Content-Type: application/json
X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF
Content-Length: 173
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "adminInfo": {
        "country": "chinaPR",
        "email": "zhangsan@huawei.com",
        "name": "zhangsan@corp",
        "phone": "+86191****9092"
    },
    "basicInfo": {
        "country": "chinaPR",
        "description": "description",
        "email": "zhangsan@huawei.com",
        "fax": "+123456789",
        "name": "Huawei Technologies Co., Ltd.",
        "phone": "+86191****9092"
    },
    "groupId": "297e87ec7713734b01771458c2d80000",
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 143
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 26701eb8f982b175b70776316d46e345

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"adminInfo": {"country": "chinaPR","email": "zhangsan@huawei.com","name": "zhangsan@corp","phone": "+86191****9092"},"basicInfo": {"country": "chinaPR","description": "description","email": "zhangsan@huawei.com","fax": "+123456789","name": "Huawei Technologies Co., Ltd.","phone": "+86191****9092"}"groupId": "297e87ec7713734b01771458c2d80000"}' 
https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911

Parent topic: APIs

Previous topic: Querying Enterprise Details as an SP Administrator

Next topic: Querying Enterprises in Pages as an SP Administrator