Skip to main content
POST
/
v2
/
tags
/
objects
/
remove
Remove tag objects
curl --request POST \
  --url https://api.uat.frankie.one/v2/tags/objects/remove \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "tagIds": [
    "12345678-1234-1234-1234-123456789012",
    "87654321-4321-4321-4321-210987654321"
  ],
  "objects": [
    {
      "objectId": "12345678-1234-1234-1234-123456789012"
    }
  ],
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "untaggedObjects": [
    {
      "objectId": "12345678-1234-1234-1234-123456789012",
      "tags": [
        {
          "tagId": "12345678-1234-1234-1234-123456789012",
          "label": "ROMANCE_SCAM",
          "mappingId": "12345678-1234-1234-1234-123456789012",
          "description": "Indicates a potential romance scam.",
          "category": "FRAUD",
          "domain": "ACTIVITY_MONITORING"
        }
      ]
    }
  ]
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

​
X-Frankie-Username
string

Username provided by API caller

Example:

"fred.flintstone@frankieone.com"

Body

application/json

Request to remove tag mappings from one or more objects.

​
tagIds
string<uuid>[]
required

IDs of the tags to remove from the specified objects. All tag IDs must exist and be accessible to the customer — if any are invalid or belong to a different tenant, the entire request fails with no partial deletions (atomic failure).

Minimum array length: 1
Example:
[
  "12345678-1234-1234-1234-123456789012",
  "87654321-4321-4321-4321-210987654321"
]
​
objects
object[]
required

Objects from which to remove the specified tag mappings.

Minimum array length: 1
​
comment
object

Optional comment to be recorded in the audit log for this action.

Response

OK

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
untaggedObjects
object[]
required

Objects that had their tag mappings removed, including the removed tags.