Assign or unassign tags to resources

This can be used for both accounts and campaigns. Please check the resource_type field for more information.

POST /api/v2/custom-tags/toggle-resource

Assign or unassign tags to resources

cURL

curl --request POST \
  --url https://api.instantly.ai/api/v2/custom-tags/toggle-resource \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tag_ids": [
    "019e3bd1-b578-7d32-9ad0-e17a94a68f84"
  ],
  "resource_type": 1,
  "resource_ids": [
    "resource-1"
  ],
  "assign": true
}
'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

tag_ids · string<uuid>[] · required

The list of tag ids to assign or unassign

resource_type · enum<number> · required

The resource type to assign or unassign the tags to

Available options: 1, 2

Example:

1

resource_ids · string[] · required

The list of resource ids to assign or unassign. A resource id is the id of an account or a campaign.

assign · boolean · required

Whether to assign the tags to the resources.

Example:

true

selected_all · boolean

Whether to select all resources.

Example:

false

filter · object

The filter to apply to the resources. These are only used when selected_all is true.

Show child attributes

Response

200

application/json

Default Response

success · boolean

Example:

true