DevelopersAPI reference
Add a path alias
Makes an old path on the code's custom domain open the code, so codes printed with that link keep working.
Send the path after the domain (/r/abc) or the whole old link on the code's domain. The rules are the dashboard's, with its reasons as the error messages:
- The code has to be on a verified custom domain of the workspace, with custom domains on the plan (Pro and Business).
- The path matches exactly and capitals count. The query string and a
/at the end are dropped. - At most 200 characters and 8 parts separated by
/, each made of letters, digits,-,_,.and~. - A path that fits a back-half (one part of 3 to 64 letters, digits,
-or_) can't be an alias: give the code that back-half instead. - QRdx keeps
/api/…,/stats/…,/q/…, GS1 Digital Links (/01/…) and files such as/robots.txtfor itself. - On a domain, each path opens one code.
/p/<x>is refused while a code there has the back-half x, because its hosted page answers at that path. - A code can have up to 5 path aliases.
A new alias is a 201. A path the code already has returns that alias with a 200. A domain's first alias can take a minute to start answering.
Scope: codes:write, for API keys and OAuth tokens alike.
AuthorizationBearer <qrdx_ followed by 40 letters and digits>An API key, sent as Authorization: Bearer qrdx_…. Create one in Settings → API keys & apps: it is shown once. A key acts on the workspace it was created in as its creator, with their current role there, and only within its scopes, the same scopes as OAuth (each operation names the one it needs). API keys.
id*stringThe code's id
1 <= length <= 64application/json- body
An old path on the code's custom domain
path*stringThe old path on the code's custom domain, such as /r/abc, or the whole old link on that domain (https://go.example.com/r/abc). The query string and a / at the end are dropped.
length <= 2048The code already had this path: its alias
application/json- response
data*An old path on a code's custom domain that also opens the code
curl -X POST 'https://api.qrdx.dev/v1/codes/cm5code0spring0menu00001/aliases' \ -H 'Content-Type: application/json' \ -d '{ "path": "/r/abc"}'{ "data": { "id": "cm5alias0old0flyer0link01", "path": "/r/abc", "url": "https://go.example.com/r/abc", "createdAt": "2026-01-05T09:30:00.000Z" }}Was this page helpful?
Last updated on