Set individuals-AI Guardrails(AI Guardrails)-阿里云帮助中心

Modifies the name and description of an individual.

QPS limits

This operation supports up to 20 calls per second per account. Exceeding this limit triggers throttling, which may affect your business. We recommend that you take note of this limit when calling this operation.

Request syntax

POST /green/sface/person/update HTTPS|HTTP

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request parameters

Parameter	Type	Required	Example	Description
clientInfo	JSONObject	No	{"userId":"120234234","userNick":"Mike","userType":"others"}	The client information serialized from the ClientInfo structure in JSON format. Includes the unique machine identifier (UMID) and International Mobile Equipment Identity (IMEI). For more information, see ClientInfo.

Request body

Parameter	Type	Required	Example	Description
personId	String	Yes	person1	The ID of the individual to update.
name	String	No	Tom	The name of the individual.
note	String	No	Male	The description of the individual.

Response parameters

All responses return JSON-formatted data. For more information about common response parameters, see Common response parameters.

In general, the data field contains business-related data as a JSON object or array.

The data field may be empty when an error occurs.

The following table describes the fields returned in data.

Parameter	Type	Example	Description
code	Integer	200	The HTTP status code. For more information, see Common error codes.
personId	String	person1	The ID of the individual.

Examples

Request example

POST /green/sface/person/update HTTP/1.1
Common request headers
{
    "personId": "person1",
    "name": "Tom",
    "note": "Male"
}

Success response example

{
    "msg": "OK",
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "personId": "person1"
    }
}

Error codes

For a list of error codes, see Service error codes.