createResponseToken
Create custom response tokens to include additional data in Adobe Target activity responses, enabling custom tracking and integration with analytics or tag management systems.
Instructions
Create a NEW CUSTOM response token to include data in Adobe Target activity responses.
IMPORTANT: This tool creates NEW custom tokens only. Many common tokens already exist in your account:
System tokens (experience.id, activity.name, geo.city, etc.) already exist with deletable: false
These existing tokens can only be ACTIVATED/DEACTIVATED in the Target UI (Administration > Response Tokens)
Use this tool to create NEW custom tokens that don't already exist
To check existing tokens, use listResponseTokens first.
Response tokens make additional data available in Target's response payload (mbox.js, at.js).
TOKEN TYPES (for creating NEW tokens):
BUILT_IN - System-level tokens (e.g., experience.id, activity.name) Example: { token: "experience.id", type: "BUILT_IN" }
ACTIVITY - Activity-based attributes (e.g., activity.name, campaign.id) Example: { token: "activity.name", type: "ACTIVITY" }
GEO - Geographic data (e.g., geo.city, geo.country) Example: { token: "geo.city", type: "GEO" }
CRS - Customer Record Service attributes Example: { token: "crs.customAttribute", type: "CRS" }
MBOX - Custom mbox parameters passed in requests (MOST COMMON FOR NEW TOKENS) Example: { token: "profile.userType", type: "MBOX" } Example: { token: "profile.productId", type: "MBOX" } Note: Mbox parameters must be passed by your implementation (at.js/mobile SDK) This is the most common type for creating custom response tokens
SCRIPT - Profile script outputs (e.g., profile.scriptName) Example: { token: "profile.userSegment", type: "SCRIPT" }
IMPORTANT LIMITATION: Profile scripts CANNOT be created via the Admin API. You must create profile scripts in the Target UI first:
Navigate to Audiences > Profile Scripts
Create your script (e.g., "userSegment")
Then create the response token: { token: "profile.userSegment", type: "SCRIPT" }
COMMON USE CASES FOR CUSTOM TOKENS:
Custom tracking: Create tokens for your specific mbox parameters (profile.userType, profile.campaignId, etc.) Business data: Return custom business attributes in responses Integration: Pass custom data to analytics or tag management systems
BEFORE CREATING:
Run listResponseTokens to check if the token already exists
If it exists with deletable: false, activate it in Target UI instead
If it doesn't exist, create it with this tool
WORKFLOW FOR SCRIPT TOKENS:
Create profile script in Target UI (Audiences > Profile Scripts)
Use this tool to create response token referencing that script
Response token becomes available in Target responses
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Response token ID (optional) | |
| type | Yes | Token type - see description for details and limitations | |
| token | Yes | Token identifier (e.g., "experience.id", "profile.scriptName", "geo.city") |