get_campaign_url_info.md

nav_title	layout	page_type	hidden	permalink	platform	channel	tool	description
GET: List Link Alias for Campaigns	api_page	reference	true	/get_campaign_link_alias/	API	Email	Canvas Campaigns	This article outlines details about the List link alias Braze endpoint.

{% api %}

List link alias for campaign

{% apimethod get %} /campaigns/url_info/details {% endapimethod %}

Use this endpoint to list the link alias set in a specific campaign message variant.

{% apiref postman %} {% endapiref %}

Request parameters

Parameter	Required	Data Type	Description
campaign_id	Required	String	See campaign API identifier.
message_variation_id	Required	String	Message variant API identifier. You can find this on the campaign details page for a campaign, under the API Identifier section.
includes_link_id	Optional	String	A specific link identifier (as assigned by Braze) or null. This is used to filter the results by a specific link_id.
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

Example request

curl --location --request GET 'https://rest.iad-01.braze.com/campaigns/url_info/details?campaign_id=4615a404-b2c2-421e-9a04-2233bb3ec4f9&message_variation_id=0ea708fe-36b4-43f7-9f5c-a0650ea2a7a0&includes_link_id=014tk4e0kg97' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "channel": "email",
  "name": "Variant 1",
  "link_data": [
    {
      "link_URL": "https://www.braze.com?lid=014tk4e0kg97",
      "link_id": "014tk4e0kg97",
      "content_block_path_info": [],
      "link_alias": "link5"
    }
  ],
  "message": "success"
}

Troubelshooting

The following table lists possible returned errors and their associated troubleshooting steps.

Error	Troubleshooting
Missing/Invalid Campaign ID	The campaign API ID must be an API identifier. You can find this using the Export campaigns list endpoint or by logging into the dashboard.
Missing/Invalid Message Variant ID	The message variant API ID must be an API identifier. You can find this using the Export campaign details endpoint or by logging into the dashboard.
{: .reset-td-br-1 .reset-td-br-2}

{% endapi %}