Skip to content

List link alias for Canvas

get

/canvas/url_info/details

Use this endpoint to list the link alias set in a specific email Canvas step.

Request parameters

Parameter Required Data Type Description
canvas_step_id Required String See Canvas step API identifier.
message_variation_id Required String Message variant API identifier (for the email message variant in that step). You can find this by clicking Analyze Variants on the Canvas Details page.
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.

Example request

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/canvas/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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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"
}

Troubleshooting

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

Error Troubleshooting
Missing/Invalid Canvas ID The Canvas API ID must be an API identifier. You can find this using the Export Canvas 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 Canvas details endpoint or by logging into the dashboard.
New Stuff!