curl --request POST \
--url https://api.anchorage-staging.com/v2/tags/apply \
--header 'Api-Access-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "abc123",
"entityType": "withdrawal",
"tags": [
"<string>"
]
}
'import requests
url = "https://api.anchorage-staging.com/v2/tags/apply"
payload = {
"entityId": "abc123",
"entityType": "withdrawal",
"tags": ["<string>"]
}
headers = {
"Api-Access-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entityId: 'abc123', entityType: 'withdrawal', tags: ['<string>']})
};
fetch('https://api.anchorage-staging.com/v2/tags/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"tags": [
{
"createdAt": "2023-11-07T05:31:56Z",
"name": "urgent",
"tagType": "system",
"updatedAt": "2023-11-07T05:31:56Z",
"version": 1
}
]
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}Apply tags to an entity
Apply a set of tags to an entity, replacing the entity’s existing tags of the given tag type. Tags are auto-created if they do not exist, and an empty list clears the entity’s tags of that type.
curl --request POST \
--url https://api.anchorage-staging.com/v2/tags/apply \
--header 'Api-Access-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "abc123",
"entityType": "withdrawal",
"tags": [
"<string>"
]
}
'import requests
url = "https://api.anchorage-staging.com/v2/tags/apply"
payload = {
"entityId": "abc123",
"entityType": "withdrawal",
"tags": ["<string>"]
}
headers = {
"Api-Access-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entityId: 'abc123', entityType: 'withdrawal', tags: ['<string>']})
};
fetch('https://api.anchorage-staging.com/v2/tags/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"tags": [
{
"createdAt": "2023-11-07T05:31:56Z",
"name": "urgent",
"tagType": "system",
"updatedAt": "2023-11-07T05:31:56Z",
"version": 1
}
]
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}{
"errorType": "InternalError",
"message": "Missing required field 'amount'."
}Authorizations
An API key associated with a security role
Body
The ID of the entity to tag
"abc123"
The type of entity being tagged (e.g. transfer, withdrawal)
"withdrawal"
The complete set of tag names for the entity within the given tag type. Apply replaces the entity's tags of that type with this set: names not already present are added, names no longer present are removed, and an empty list clears all of the entity's tags of that type. Tags of other types are not affected.
The ownership type of a tag.
system, backoffice, client Response
Tags applied successfully
The tags applied to the entity, including their association metadata
Show child attributes
Show child attributes
Was this page helpful?