Remove person modification tag

Prev Next

Available in VPC

Remove the specified item from tags registered to a person.

Request

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

Method URI
DELETE /api/v1/workspaces/{workspace_name}/persons/{person_id}/person-tags

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 Integer Required Person ID

Request body

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

Field Type Required Description
tagIds Array<Integer> Required List of tag IDs to remove
  • Tag IDs that don't exist or have already been removed are ignored.

Request example

The request example is as follows:

curl --location --request DELETE 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001/person-tags' \
--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 '{
  "tagIds": [200]
}'

Response

This section describes the response format.

Response body

Field Type Required Description
code String Required API processing result code
message String Required API processing result message
result Object Required Person tag list object

result

Field Type Required Description
tagList Array Required List of tags finally registered to the person
  • Complete list, excluding tags removed by request
tagList[].id Integer Required Person tag ID
tagList[].name String Required Person tag name

Response status codes

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

Response example

{
  "code": "0",
  "message": "success",
  "result": {
    "tagList": [
      {
        "id": 100,
        "name": "Anchor"
      }
    ]
  }
}