About iQ Profiles API
iQ Profiles uses JSON objects to retrieve data from an iQ Tag Management account profile and update the basic JavaScript Code extension, which allows you to use custom code deployment processes to manage iQ Tag Management profiles.
How it works
iQ Profiles is an API endpoint that makes your iQ Tag Management configuration available programmatically. Use this endpoint to retrieve specific configuration components, such as tags, extensions, and load rules, and to add, edit, and delete a limited subset of components.
Use this API to access the versions and change history of your profiles and integrate your own SDLC.
iQ Profiles currently supports two requests:
- GET
Returns specific content about iQ Tag Management account profiles, including: load rules, tags, extensions, variables, and version IDs. - PATCH
Perform create, update, and delete operations on a limited subset of configuration components. Using this method results in new saved versions of your profile.
Working with profiles
When updating a profile, iQ Profiles checks for concurrent users and will lock the profile to protect against concurrent changes. If another user is viewing the same profile or the profile has just been updated (within 15 seconds), the PATCH method will receive an error.
Saving, versioning, and publishing
Using the PATCH request to update a profile creates a new version in the application, equivalent to a “Save As” operation. To distinguish versions generated by the API from versions created in the application, the API formats the version name as "API | {timestamp}".
To publish this profile, log into the application, navigate to the latest saved version of your profile after the patch and publish.
Permission requirements
- GET Profile
Save and Save as New Versions permission - PATCH Profile
Save Existing Versions or Save as New Versions permission
Authentication
The bearer token is used to authenticate all API calls and not the API key. The API key is only used in the authentication call. In addition to the bearer token, the authentication response includes a region-specific hostname that must be used in subsequent server-side API calls.
See the Tealium API V3 Getting Started guide to learn about generating a bearer token from the API key.
This page was last updated: January 30, 2023