generateLink
- 09 Dec 2024
- DarkLight
generateLink
- Updated on 09 Dec 2024
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/publishers/{publisherId}/linkbuilder/generate
This API is Available on Zapier
Automate your workflows with Zapier's easy to use workflow builder. Read more here or go directly our Zapier Integration Page.
POST generate a tracking link
Publishers can post a destination URL for an advertiser to generate an Awin tracking link. This endpoint allows you to either generate a single tracking link or batches of up to 100 tracking links.
Who can use it?
Publishers
Header parameters
Authorization
string
accessToken
Path parameters
publisherId
integer (int64) Required
publisherId
Query parameters
accessToken
stringRequired
access token
Body parameters
requestBody
object
advertiserId
integer (int64)
destinationUrl
string
parameters
object (Parameters)
campaign
string
clickref
string
clickref2
string
clickref3
string
clickref4
string
clickref5
string
clickref6
string
shorten
boolean
| Field name | Required? | Type | Description |
| advertiserId | Yes | Interger | ID of the advertiser you are creating a link to |
| destinationUrl | No | String | The specific page you wish to link to. If not provided, the advertiser’s default landing page is used. |
| parameters | No | Object | This can contain any of the Awin click parameters. |
| shorten | No | Boolean | If set to true, will response will return a shortened link URL along with the standard long link. |
Responses
200
OK
object
Note: If successful, a 200 response code is given, along with JSON of the following form:
{
"url": "https://www.awin1.com/....",
"shortUrl": "https://tidd.ly/...." //if shorten true
}
If the response contains "description": "Unknown error! Please try again later!" for some single advertisers, they do not allow the link builder.
Was this article helpful?