Updating an Account

Function

This API is used to update an account. It can be called only from the management account of the organization.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:accounts:update	Write	account *	g:ResourceTag/<tag-key>	-	-

URI

PATCH /v1/organizations/accounts/{account_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
account_id	Yes	String	Unique ID of an account.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Description. If you set the parameter to an empty string, the description is empty. If you set it to NULL, no operations are required.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
account	AccountDto object	Information about the member accounts in an organization.

**Table 5** AccountDto
Parameter	Type	Description
id	String	Unique ID of an account.
urn	String	Uniform resource name of the account.
join_method	String	How an account joined an organization.
status	String	Account status. It can be active, suspended, or pending_closure.
joined_at	String	Date when an account joined an organization.
name	String	Account name.
mobile_phone	String	Mobile number.
intl_number_prefix	String	Prefix of a mobile number.
email	String	Email address associated with the account.
description	String	Description.

Example Requests

Updating an account

PATCH /v1/organizations/accounts/{account_id}

{
  "description" : "string"
}

Example Responses

Status code: 200

Successful

{
  "account" : {
    "id" : "05261f923e80d3890f33c0056e9b3f80",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80",
    "join_method" : "invited",
    "status" : "active",
    "joined_at" : "2022-08-24T06:41:15Z",
    "name" : "paas_iam_573331",
    "description" : "string"
  }
}