Edit person

Available in VPC

Edit person information.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
PATCH	/api/v1/workspaces/{workspace_name}/persons/{person_id}

Request headers

For information about the headers common to all Media Intelligence APIs, see Media Intelligence request headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`workspace_name`	String	Required	Workspace name
`person_id`	String	Required	Person ID See Get people list.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`name`	String	Optional	Person name 1-50 characters Can't be duplicated within a workspace. Can't be registered if it contains a blank string or only spaces.
`description`	String	Optional	Person description 1-700 characters
`primaryThumbnailId`	Integer	Optional	Main thumbnail ID See Person thumbnail list.

Request example

The request example is as follows:

curl --location --request PATCH 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Jae-suk Yoo",
  "description": "He's the representative MC in Korea.",
  "primaryThumbnailId": 3002
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	String	Required	API processing result code
`message`	String	Required	API processing result message
`result`	Object	Required	Person details object

result

Field	Type	Required	Description
`id`	Integer	Required	Person ID
`name`	String	Required	Person name
`description`	String	Optional	Person description
`tags`	Array	Required	List of tags set for the person 0 and up
`tags[].id`	Integer	Required	Tag ID
`tags[].name`	String	Required	Tag name
`thumbnails`	Array	Required	List of thumbnails registered for the person 0 and up
`thumbnails[].id`	Integer	Required	Thumbnail ID
`thumbnails[].url`	String	Required	Thumbnail image URL (presigned URL)
`thumbnails[].isPrimaryThumbnail`	Boolean	Required	Whether it is a main thumbnail true \| false

Response status codes

For information about the HTTP status codes common to all Media Intelligence APIs, see Media Intelligence response status codes.

Response example

The response example is as follows:

{
  "code": "0",
  "message": "success",
  "result": {
    "id": 1001,
    "name": "Jae-suk Yoo",
    "description": "He's the representative MC in Korea.",
    "tags": [
      {
        "id": 202,
        "name": "Actor"
      }
    ],
    "thumbnails": [
      {
        "id": 3002,
        "url": "https://kr.object.ncloudstorage.com/.../9870829644790204567.jpg?...",
        "isPrimaryThumbnail": true
      }
    ]
  }
}