--- title: "Create a new TrackingLink." method: POST path: "/cm/v1/tracking-links" tags: ["TrackingLink"] --- # Create a new TrackingLink. `POST /cm/v1/tracking-links` Create a new TrackingLink of the Product. ## Query parameters - `ad_account_id` string, required - `product_id` string, required ## Request body - DspTrackingLink — TrackingLink represents an AdAccount's configuration for. - `id` string — Unique identifier of the TrackingLink. Automatically set by server on creation. - `ad_account_id` string — The ID of the AdAccount the TrackingLink belongs to. - `product_id` string — The ID of the Product the TrackingLink belongs to. - `title` string, required — A descriptive name of the TrackingLink. - `description` string — An optional description about the TrackingLink. - `device_os` 'UNKNOWN_DEVICE_OS' | 'ANDROID' | 'IOS' | 'VERSATILE' | 'MOBILE_WEB' | 'MACOS' | 'WINDOWS' | 'NEXT_VERSATILE', required — Enumeration of device OS types supported by Moloco Ads. This value is not part of the specification. - ANDROID: Android device OS. - IOS: iOS device OS. - VERSATILE: Product with multiple OSes. Specifically for CTV. - MOBILE_WEB: OS for mobile web traffic. - MACOS: OS for MacOS traffic. - WINDOWS: OS for Windows traffic. - NEXT_VERSATILE: OS for Next web product. - `click_through_link` TrackingLinkUrlData, required - `url` string, required — URL of the TrackingLink. - `status` 'UNKNOWN_VERIFICATION_STATUS' | 'UNVERIFIED' | 'VERIFYING' | 'VERIFIED' — Enumeration of various TrackingLink verification status. This value is not part of the specification. - UNVERIFIED: The TrackingLink is not yet verified. - VERIFYING: The TrackingLink is being verified. - VERIFIED: The TrackingLink has been verified. - `unverified_status_data` UrlDataUnverifiedStatusData — UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration. - `stored_at` string, date-time — Creation time of this link. - `user_id` string — The ID of the user who created this link. - `verifying_status_data` UrlDataVerifyingStatusData — VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state indefinitely until receiving a postback. - `attempt_ids` string[] — Each of ID refers to a TrackingLinkVerificationAttempt. - `verified_status_data` UrlDataVerifiedStatusData — VerifiedStatusData represents the information of the completed verification. - `verified_attempt` DspTrackingLinkVerificationAttempt — TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink. - `id` string — The ID of the TrackingLinkVerificationAttempt. - `ad_account_id` string — The AdAccount ID that this attempt belongs to. - `tracking_link_id` string — The ID of the TrackingLink that this attempt belongs to. - `url_data_type` 'UNKNOWN_URL_DATA_TYPE' | 'CT_LINK' | 'VT_LINK' — The type of the UrlData that this attempt belongs to. - `user_id` string — The ID of the user who is conducting the link verification. - `user_email` string — The user's email. - `user_name` string — The user's name. - `tracking_bundle_id` string — The tracking bundle value appears at the postback event. - `resolved_url` string — The URL sent to the MMP for the verification test. This is the macro expansion result of the original link URL. - `resolved_idfa` string — The IDFA value used to generate the resolved_url. - `started_at` string, date-time — The starting time of the verification. - `verified_at` string, date-time — The time when the verification test is completed. - `view_through_link` TrackingLinkUrlData - `url` string, required — URL of the TrackingLink. - `status` 'UNKNOWN_VERIFICATION_STATUS' | 'UNVERIFIED' | 'VERIFYING' | 'VERIFIED' — Enumeration of various TrackingLink verification status. This value is not part of the specification. - UNVERIFIED: The TrackingLink is not yet verified. - VERIFYING: The TrackingLink is being verified. - VERIFIED: The TrackingLink has been verified. - `unverified_status_data` UrlDataUnverifiedStatusData — UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration. - `stored_at` string, date-time — Creation time of this link. - `user_id` string — The ID of the user who created this link. - `verifying_status_data` UrlDataVerifyingStatusData — VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state indefinitely until receiving a postback. - `attempt_ids` string[] — Each of ID refers to a TrackingLinkVerificationAttempt. - `verified_status_data` UrlDataVerifiedStatusData — VerifiedStatusData represents the information of the completed verification. - `verified_attempt` DspTrackingLinkVerificationAttempt — TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink. - `id` string — The ID of the TrackingLinkVerificationAttempt. - `ad_account_id` string — The AdAccount ID that this attempt belongs to. - `tracking_link_id` string — The ID of the TrackingLink that this attempt belongs to. - `url_data_type` 'UNKNOWN_URL_DATA_TYPE' | 'CT_LINK' | 'VT_LINK' — The type of the UrlData that this attempt belongs to. - `user_id` string — The ID of the user who is conducting the link verification. - `user_email` string — The user's email. - `user_name` string — The user's name. - `tracking_bundle_id` string — The tracking bundle value appears at the postback event. - `resolved_url` string — The URL sent to the MMP for the verification test. This is the macro expansion result of the original link URL. - `resolved_idfa` string — The IDFA value used to generate the resolved_url. - `started_at` string, date-time — The starting time of the verification. - `verified_at` string, date-time — The time when the verification test is completed. - `ctv_adjust_dual_vt_link` TrackingLinkUrlData - `url` string, required — URL of the TrackingLink. - `status` 'UNKNOWN_VERIFICATION_STATUS' | 'UNVERIFIED' | 'VERIFYING' | 'VERIFIED' — Enumeration of various TrackingLink verification status. This value is not part of the specification. - UNVERIFIED: The TrackingLink is not yet verified. - VERIFYING: The TrackingLink is being verified. - VERIFIED: The TrackingLink has been verified. - `unverified_status_data` UrlDataUnverifiedStatusData — UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration. - `stored_at` string, date-time — Creation time of this link. - `user_id` string — The ID of the user who created this link. - `verifying_status_data` UrlDataVerifyingStatusData — VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state indefinitely until receiving a postback. - `attempt_ids` string[] — Each of ID refers to a TrackingLinkVerificationAttempt. - `verified_status_data` UrlDataVerifiedStatusData — VerifiedStatusData represents the information of the completed verification. - `verified_attempt` DspTrackingLinkVerificationAttempt — TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink. - `id` string — The ID of the TrackingLinkVerificationAttempt. - `ad_account_id` string — The AdAccount ID that this attempt belongs to. - `tracking_link_id` string — The ID of the TrackingLink that this attempt belongs to. - `url_data_type` 'UNKNOWN_URL_DATA_TYPE' | 'CT_LINK' | 'VT_LINK' — The type of the UrlData that this attempt belongs to. - `user_id` string — The ID of the user who is conducting the link verification. - `user_email` string — The user's email. - `user_name` string — The user's name. - `tracking_bundle_id` string — The tracking bundle value appears at the postback event. - `resolved_url` string — The URL sent to the MMP for the verification test. This is the macro expansion result of the original link URL. - `resolved_idfa` string — The IDFA value used to generate the resolved_url. - `started_at` string, date-time — The starting time of the verification. - `verified_at` string, date-time — The time when the verification test is completed. - `tracking_company` 'UNKNOWN_TRACKING_COMPANY' | 'KOCHAVA' | 'ADJUST' | 'MAT' | 'MOLOCO_PIXEL' | 'APPSFLYER' | 'ADBRIX' | 'WEB' | 'GENERIC' | 'TRACKFNT' | 'AIRBRIDGE' | 'MOLOCO_E2E' | 'APSALAR' | 'BRANCH' | 'TENJIN' | 'SINGULAR' | 'ADBRIX_V2' | 'TRAFFICGUARD' | 'GAMELOFT' | 'SKADNETWORK' | 'MYTRACKER' | 'MOLOCO_RMP' | 'MOLOCO_PIXEL_V2' | 'JUSTTRACK' | 'SHOPEE' | 'KOCHAVA_FOR_PUBLISHER' | 'GAMESIGHT' | 'CAULY' | 'HASOFFER' | 'ADACTION' | 'CURATE' — Enumeration for tracking companies supported by Moloco Ads. - WEB: Unnamed trackers - AIRBRIDGE: Moloco's e2e tracker (test purpose only) - KOCHAVA_FOR_PUBLISHER: Kochava's CTV to web event dedicated tracking company. - `created_at` string, date-time — Created time. - `updated_at` string, date-time — Last updated time. Should not modify on the client side. ## Response `200` A successful response. - MessagesCreateTrackingLinkResponse - `tracking_link` DspTrackingLink — TrackingLink represents an AdAccount's configuration for. - `id` string — Unique identifier of the TrackingLink. Automatically set by server on creation. - `ad_account_id` string — The ID of the AdAccount the TrackingLink belongs to. - `product_id` string — The ID of the Product the TrackingLink belongs to. - `title` string, required — A descriptive name of the TrackingLink. - `description` string — An optional description about the TrackingLink. - `device_os` 'UNKNOWN_DEVICE_OS' | 'ANDROID' | 'IOS' | 'VERSATILE' | 'MOBILE_WEB' | 'MACOS' | 'WINDOWS' | 'NEXT_VERSATILE', required — Enumeration of device OS types supported by Moloco Ads. This value is not part of the specification. - ANDROID: Android device OS. - IOS: iOS device OS. - VERSATILE: Product with multiple OSes. Specifically for CTV. - MOBILE_WEB: OS for mobile web traffic. - MACOS: OS for MacOS traffic. - WINDOWS: OS for Windows traffic. - NEXT_VERSATILE: OS for Next web product. - `click_through_link` TrackingLinkUrlData, required - `url` string, required — URL of the TrackingLink. - `status` 'UNKNOWN_VERIFICATION_STATUS' | 'UNVERIFIED' | 'VERIFYING' | 'VERIFIED' — Enumeration of various TrackingLink verification status. This value is not part of the specification. - UNVERIFIED: The TrackingLink is not yet verified. - VERIFYING: The TrackingLink is being verified. - VERIFIED: The TrackingLink has been verified. - `unverified_status_data` UrlDataUnverifiedStatusData — UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration. - `stored_at` string, date-time — Creation time of this link. - `user_id` string — The ID of the user who created this link. - `verifying_status_data` UrlDataVerifyingStatusData — VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state indefinitely until receiving a postback. - `attempt_ids` string[] — Each of ID refers to a TrackingLinkVerificationAttempt. - `verified_status_data` UrlDataVerifiedStatusData — VerifiedStatusData represents the information of the completed verification. - `verified_attempt` DspTrackingLinkVerificationAttempt — TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink. - `id` string — The ID of the TrackingLinkVerificationAttempt. - `ad_account_id` string — The AdAccount ID that this attempt belongs to. - `tracking_link_id` string — The ID of the TrackingLink that this attempt belongs to. - `url_data_type` 'UNKNOWN_URL_DATA_TYPE' | 'CT_LINK' | 'VT_LINK' — The type of the UrlData that this attempt belongs to. - `user_id` string — The ID of the user who is conducting the link verification. - `user_email` string — The user's email. - `user_name` string — The user's name. - `tracking_bundle_id` string — The tracking bundle value appears at the postback event. - `resolved_url` string — The URL sent to the MMP for the verification test. This is the macro expansion result of the original link URL. - `resolved_idfa` string — The IDFA value used to generate the resolved_url. - `started_at` string, date-time — The starting time of the verification. - `verified_at` string, date-time — The time when the verification test is completed. - `view_through_link` TrackingLinkUrlData - `url` string, required — URL of the TrackingLink. - `status` 'UNKNOWN_VERIFICATION_STATUS' | 'UNVERIFIED' | 'VERIFYING' | 'VERIFIED' — Enumeration of various TrackingLink verification status. This value is not part of the specification. - UNVERIFIED: The TrackingLink is not yet verified. - VERIFYING: The TrackingLink is being verified. - VERIFIED: The TrackingLink has been verified. - `unverified_status_data` UrlDataUnverifiedStatusData — UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration. - `stored_at` string, date-time — Creation time of this link. - `user_id` string — The ID of the user who created this link. - `verifying_status_data` UrlDataVerifyingStatusData — VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state indefinitely until receiving a postback. - `attempt_ids` string[] — Each of ID refers to a TrackingLinkVerificationAttempt. - `verified_status_data` UrlDataVerifiedStatusData — VerifiedStatusData represents the information of the completed verification. - `verified_attempt` DspTrackingLinkVerificationAttempt — TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink. - `id` string — The ID of the TrackingLinkVerificationAttempt. - `ad_account_id` string — The AdAccount ID that this attempt belongs to. - `tracking_link_id` string — The ID of the TrackingLink that this attempt belongs to. - `url_data_type` 'UNKNOWN_URL_DATA_TYPE' | 'CT_LINK' | 'VT_LINK' — The type of the UrlData that this attempt belongs to. - `user_id` string — The ID of the user who is conducting the link verification. - `user_email` string — The user's email. - `user_name` string — The user's name. - `tracking_bundle_id` string — The tracking bundle value appears at the postback event. - `resolved_url` string — The URL sent to the MMP for the verification test. This is the macro expansion result of the original link URL. - `resolved_idfa` string — The IDFA value used to generate the resolved_url. - `started_at` string, date-time — The starting time of the verification. - `verified_at` string, date-time — The time when the verification test is completed. - `ctv_adjust_dual_vt_link` TrackingLinkUrlData - `url` string, required — URL of the TrackingLink. - `status` 'UNKNOWN_VERIFICATION_STATUS' | 'UNVERIFIED' | 'VERIFYING' | 'VERIFIED' — Enumeration of various TrackingLink verification status. This value is not part of the specification. - UNVERIFIED: The TrackingLink is not yet verified. - VERIFYING: The TrackingLink is being verified. - VERIFIED: The TrackingLink has been verified. - `unverified_status_data` UrlDataUnverifiedStatusData — UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration. - `stored_at` string, date-time — Creation time of this link. - `user_id` string — The ID of the user who created this link. - `verifying_status_data` UrlDataVerifyingStatusData — VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state indefinitely until receiving a postback. - `attempt_ids` string[] — Each of ID refers to a TrackingLinkVerificationAttempt. - `verified_status_data` UrlDataVerifiedStatusData — VerifiedStatusData represents the information of the completed verification. - `verified_attempt` DspTrackingLinkVerificationAttempt — TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink. - `id` string — The ID of the TrackingLinkVerificationAttempt. - `ad_account_id` string — The AdAccount ID that this attempt belongs to. - `tracking_link_id` string — The ID of the TrackingLink that this attempt belongs to. - `url_data_type` 'UNKNOWN_URL_DATA_TYPE' | 'CT_LINK' | 'VT_LINK' — The type of the UrlData that this attempt belongs to. - `user_id` string — The ID of the user who is conducting the link verification. - `user_email` string — The user's email. - `user_name` string — The user's name. - `tracking_bundle_id` string — The tracking bundle value appears at the postback event. - `resolved_url` string — The URL sent to the MMP for the verification test. This is the macro expansion result of the original link URL. - `resolved_idfa` string — The IDFA value used to generate the resolved_url. - `started_at` string, date-time — The starting time of the verification. - `verified_at` string, date-time — The time when the verification test is completed. - `tracking_company` 'UNKNOWN_TRACKING_COMPANY' | 'KOCHAVA' | 'ADJUST' | 'MAT' | 'MOLOCO_PIXEL' | 'APPSFLYER' | 'ADBRIX' | 'WEB' | 'GENERIC' | 'TRACKFNT' | 'AIRBRIDGE' | 'MOLOCO_E2E' | 'APSALAR' | 'BRANCH' | 'TENJIN' | 'SINGULAR' | 'ADBRIX_V2' | 'TRAFFICGUARD' | 'GAMELOFT' | 'SKADNETWORK' | 'MYTRACKER' | 'MOLOCO_RMP' | 'MOLOCO_PIXEL_V2' | 'JUSTTRACK' | 'SHOPEE' | 'KOCHAVA_FOR_PUBLISHER' | 'GAMESIGHT' | 'CAULY' | 'HASOFFER' | 'ADACTION' | 'CURATE' — Enumeration for tracking companies supported by Moloco Ads. - WEB: Unnamed trackers - AIRBRIDGE: Moloco's e2e tracker (test purpose only) - KOCHAVA_FOR_PUBLISHER: Kochava's CTV to web event dedicated tracking company. - `created_at` string, date-time — Created time. - `updated_at` string, date-time — Last updated time. Should not modify on the client side. - `validation_status` 'TRACKING_LINK_VALIDATION_STATUS_UNKNOWN' | 'TRACKING_LINK_VALIDATION_STATUS_SUCCESS' | 'TRACKING_LINK_VALIDATION_STATUS_WARNING' — - TRACKING_LINK_VALIDATION_STATUS_SUCCESS: Created TrackingLink does not have any warnings. - TRACKING_LINK_VALIDATION_STATUS_WARNING: Created TrackingLink has some warnings. ## Other responses - `default` — Error. Detailed cause can be found in the `details` field. --- [API](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api.md) · [All operations](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moloco/moloco-ads-campaign-management-api/revisions/5c85d0910ac0/schema)