Assign Manual Tag

Tool name: tag-contact

Assigns one existing writable manual tag to one contact. This may immediately start or alter campaigns, autoresponders, outbound events and automations. The caller must explicitly approve those effects. Unknown, foreign or non-manual tags are rejected and never created.

Input schema

contactIdinteger, >= 1required

Numeric contact ID returned by search-contacts

manualTagIdinteger, >= 1required

Existing writable manual tag ID; unknown tags are rejected and never created

approvalstringrequired

Exactly I_ACCEPT_AUTOMATION_EFFECTS: tagging may start campaigns and automations

Value:"I_ACCEPT_AUTOMATION_EFFECTS"

referenceIdinteger, >= 0

Reference for a multi-value manual tag; use 0 for contact-wide tags

Default:0

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null

Input example

{
  "contactId": 1,
  "manualTagId": 1,
  "approval": "I_ACCEPT_AUTOMATION_EFFECTS",
  "referenceId": 0,
  "accountId": null
}

Output schema

accountIdintegerrequired

contactIdintegerrequired

manualTagIdintegerrequired

referenceIdintegerrequired

actionstringrequired

automationEffectstringrequired

editUrlstringrequired

Output example

{
  "accountId": 0,
  "contactId": 0,
  "manualTagId": 0,
  "referenceId": 0,
  "action": "string",
  "automationEffect": "string",
  "editUrl": "string"
}