Mettre à jour un lien avec l'API Dub
Modifie un lien court ; seuls les champs envoyés changent. Un nouveau domain ou key change le lien court lui-même, et archived à true masque le lien de Lister les liens.
- Identifiant
- dub_update_link
L'appel
POST https://connect.reportei.com/api/tools/dub_update_link/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"linkId": "<linkId>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| linkId | string | Oui | Id of the link, from List links, Get link or Create link. |
| url | string | Non | New destination URL. |
| domain | string | Non | Domain of the short link, without protocol, from List domains. |
| key | string | Non | Slug of the short link, the part after the domain. |
| archived | boolean | Non | true archives the link, false restores it. |
| tagIds | array | Non | Ids of all the tags of the link, from List tags or Create tag. |
| folderId | string | Non | Id of the folder of the link, from List folders. |
| comments | string | Non | Internal notes about the link. |
| utm_source | string | Non | UTM source added to the destination URL, replacing the one in it. |
| utm_medium | string | Non | UTM medium added to the destination URL, replacing the one in it. |
| utm_campaign | string | Non | UTM campaign added to the destination URL, replacing the one in it. |
| utm_term | string | Non | UTM term added to the destination URL, replacing the one in it. |
| utm_content | string | Non | UTM content added to the destination URL, replacing the one in it. |
| trackConversion | boolean | Non | true tracks leads and sales of the link. The workspace needs conversion tracking set up. |
| expiresAt | string | Non | When the link expires. |
| expiredUrl | string | Non | Where the link sends visitors after it expires. |
| proxy | boolean | Non | true shows the custom preview of title, description and image when the link is shared. |
| title | string | Non | Title of the custom preview. Used when proxy is true. |
| description | string | Non | Description of the custom preview. Used when proxy is true. |
| image | string | Non | URL of the image of the custom preview. Used when proxy is true. |
Connexions possibles
Votre client connecte son compte Dub une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/dub, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/dub_update_link. Il devient la définition de tool de votre agent sans conversion.
Autres tools Dub
- Lister les liensGETListe les liens courts du workspace avec destination, tags, dossier, paramètres UTM et les nombres de clics, leads et ventes. Pour la page suivante, envoyez l'id du dernier lien.
- Obtenir un lienGETRenvoie un lien court avec les nombres de clics, leads et ventes. Envoyez domain et key ensemble, comme dub.sh et abc123 pour dub.sh/abc123, ou envoyez linkId.
- Créer un lienPOSTRaccourcit une URL et renvoie le lien court dans shortLink, avec son id. Sans domain il utilise le domaine principal du workspace, ou dub.sh s'il n'y en a pas.
- Obtenir les analyticsGETRenvoie clics, leads ou ventes du workspace, d'un domaine, lien, tag ou dossier, en total, série temporelle ou classement choisi par groupBy.
- Lister les événementsGETListe les événements de clic, lead ou vente un par un, avec l'heure, le lien et les détails du clic et, pour les leads et ventes, le client. Exige le plan Business ou supérieur.
- Lister les domainesGETListe les domaines personnalisés du workspace, dont le slug va dans l'argument domain des tools de lien. Les pages commencent à 1, et une page plus courte que pageSize est la dernière.
- Lister les tagsGETListe les tags du workspace avec leurs ids et couleurs. Les pages commencent à 1, et une page plus courte que pageSize est la dernière.
- Créer un tagPOSTCrée un tag pour organiser les liens, comme une campagne ou un client. La réponse contient l'id qui va dans tagIds.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
