Open your profile
Click your name at the top right of any page and choose My profile. The page has two tabs, Profile and API. Changes on either tab are saved only when you click Save; Cancel leaves without saving.
Profile tab
| Field | What it does |
|---|---|
| First Name, Last Name | Your name as shown to other users, for example in "last modified by" columns. Required |
| Your email address. Required | |
| Default Landing Page | Where you land after signing in, when you did not follow a link to a specific page: Home (the Companies list) or Relay. Default Home |
What the API token is
The API token is a personal key that lets a script, a spreadsheet or another tool call the TagPipes API on your behalf. A request made with your token can see and change what you can see and change in TagPipes, in every company you have access to. Treat it like a password: do not paste it into web pages, shared documents or code that other people can read.
Generate or copy your token
- Open My profile and click the API tab.
- If API Token is empty, click Generate, then click Save.
- To copy the token, click Copy. "API Token copied to clipboard" confirms it.
Regenerate your token
Regenerate when the token may have been seen by someone else, or when a tool that used it is retired.
- On the API tab, open the arrow menu next to Copy and click Regenerate.
- Click Save.
The new token replaces the old one when you save. Anything still using the old token stops working, so update your scripts and tools with the new one.
Use the token
Send the token as the api_token parameter on each request to the TagPipes API at https://my.tagpipes.com/api/: in the query string for a GET request, or as a form field for a POST. A request with a missing or invalid token gets HTTP 401 with the error code UNAUTHORIZED.
For the list of available API calls, contact TagPipes support.
Troubleshooting
| Problem | Cause | Fix |
|---|---|---|
| The old token still works after Regenerate | The new token is not saved until you click Save | Click Save |
A script started getting 401 UNAUTHORIZED | The token was regenerated, or the script is not sending api_token | Copy the current token from My profile into the script |