Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
UrLBae (Independent Publisher)
URLBae allows you to seamlessly track your audience with simple and easy-to-remember yet powerful links and provide your customers a unique tailored experience. Want an Instagram Bio Page? We can do that too! QR Code for Crypto? We have you covered. All completely free!
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://urlbae.com/ |
| Privacy policy | https://urlbae.com/ |
| Categories | Social Media |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Token in the form "Bearer [Your_Token]" | securestring | The Token in the form "Bearer [Your_Token]" for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create a branded domain |
A domain can be added using this endpoint. You need to send the pixel type and the tag. |
| Create a pixel |
A pixel can be created using this endpoint. You need to send the pixel type and the tag. |
| Create a QR code |
To get create a single QR code via the API, you can use this endpoint. |
| Create a user |
To create a user, use this endpoint. |
| Delete a link |
To delete a link, you can use this endpoint. |
| Delete a QR code |
To delete a single QR code via the API, you can use this endpoint. |
| Delete a user |
To delete a user, use this endpoint. |
| Delete domain |
To delete a domain, you need to send a request to this endpoint. |
| Delete pixel |
To delete a pixel via the API, you can use this endpoint. |
| Get a single link |
To get details for a single link via the API, you can use this endpoint. |
| Get a single QR code |
To get details for a single QR code via the API, you can use this endpoint. |
| Get a single user |
Get data for a single user. |
| Get account |
To get information on the account, you can send a request to this endpoint and it will return data on the account. |
| List all branded domains |
To get your branded domains codes via the API, you can use this endpoint. |
| List all CTA overlays |
To get call-to-action overlays via the API, you can use this endpoint |
| List all custom splash |
To get custom splash pages via the API, you can use this endpoint. |
| List all links |
To get your links via the API, you can use this endpoint. |
| List all pixels |
To get your pixels codes via the API, you can use this endpoint. |
| List all plans |
Get a list of all plans on the platform. This endpoint is only accessible by users with admin privileges. |
| List all QR codes |
To get your QR codes via the API, you can use this endpoint. |
| List all users |
Get a list of all users on the platform. This endpoint is only accessible by users with admin privileges. |
| Shorten a link |
To shorten a single link via the API, you can use this endpoint. |
| Subscribe a user to a plan |
To subscribe a user to plan, send a PUT request to this endpoint with the plan id and user id. The type of subscription and the expiration date will need to be specified. If the expiration date is not specified, the date will be adjusted according to the type. |
| Update a domain |
A branded domain can be updated using this endpoint. |
| Update a link |
To update a link via the API, you can use this endpoint. |
| Update a pixel |
To update a pixel via the API, you can use this endpoint. |
| Update a QR code |
To update a single QR code via the API, you can use this endpoint. |
| Update account |
To update information on the account, you can send a request to this endpoint and it will update data on the account. |
Create a branded domain
- Operation ID:
- DomainCreate
A domain can be added using this endpoint. You need to send the pixel type and the tag.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Domain
|
domain | True | string |
The domain. |
|
Redirect Root
|
redirectroot | string |
The redirect root. |
|
|
Redirect 404
|
redirect404 | string |
The redirect 404. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
id | integer |
The unique identifier. |
Create a pixel
- Operation ID:
- PixelCreate
A pixel can be created using this endpoint. You need to send the pixel type and the tag.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Type
|
type | True | string |
The type. |
|
Name
|
name | True | string |
The name. |
|
Tag
|
tag | True | string |
The tag. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
id | integer |
The unique identifier. |
Create a QR code
- Operation ID:
- QRCreate
To get create a single QR code via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Type
|
type | string |
The type. |
|
|
Data
|
data | string |
The data. |
|
|
Background
|
background | string |
The background. |
|
|
Foreground
|
foreground | string |
The foreground. |
|
|
Logo
|
logo | string |
The logo. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
id | integer |
The unique identifier. |
|
Link
|
link | string |
The link. |
Create a user
- Operation ID:
- UserCreate
To create a user, use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Username
|
username | True | string |
The username. |
|
Password
|
password | True | string |
The password. |
|
Email
|
True | string |
The email address. |
|
|
Plan ID
|
planid | integer |
The identifier of the plan. |
|
|
Expiration
|
expiration | string |
The expiration date. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
|
ID
|
data.id | integer |
The unique identifier. |
|
Email
|
data.email | string |
The email address. |
|
Username
|
data.username | string |
The username. |
Delete a link
- Operation ID:
- LinkDelete
To delete a link, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Delete a QR code
- Operation ID:
- QRDelete
To delete a single QR code via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Delete a user
- Operation ID:
- UserDelete
To delete a user, use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Delete domain
- Operation ID:
- DomainDelete
To delete a domain, you need to send a request to this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Delete pixel
- Operation ID:
- PixelDelete
To delete a pixel via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Get a single link
- Operation ID:
- LinkGet
To get details for a single link via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
details.id | integer |
The unique identifier. |
|
Short URL
|
details.shorturl | string |
The short URL address. |
|
Long URL
|
details.longurl | string |
The long URL address. |
|
Title
|
details.title | string |
The title. |
|
Description
|
details.description | string |
The description. |
|
Canada
|
details.location.canada | string |
Canada. |
|
United States
|
details.location.united states | string |
United States. |
|
iPhone
|
details.device.iphone | string |
iPhone. |
|
Android
|
details.device.android | string |
Android. |
|
Expiry
|
details.expiry | string |
The expiration date. |
|
Date
|
details.date | string |
The date. |
|
Clicks
|
data.clicks | integer |
The number of clicks. |
|
Unique Clicks
|
data.uniqueClicks | integer |
The number of unique clicks. |
|
Top Countries
|
data.topCountries | integer |
The number of top countries. |
|
Top Referrers
|
data.topReferrers | integer |
The number of top referrers. |
|
Top Browsers
|
data.topBrowsers | integer |
The number of top browsers. |
|
Top OS
|
data.topOs | integer |
The number of top OS. |
|
Facebook
|
data.socialCount.facebook | integer |
Facebook. |
|
Twitter
|
data.socialCount.twitter | integer |
Twitter. |
|
Google
|
data.socialCount.google | integer |
Google. |
Get a single QR code
- Operation ID:
- QRGet
To get details for a single QR code via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
details.id | integer |
The unique identifier. |
|
Link
|
details.link | string |
The link. |
|
Scans
|
details.scans | integer |
The number of scans. |
|
Name
|
details.name | string |
The name. |
|
Date
|
details.date | string |
The date. |
|
Clicks
|
data.clicks | integer |
The number of clicks. |
|
Unique Clicks
|
data.uniqueClicks | integer |
The number of unique clicks. |
|
Unknown
|
data.topCountries.Unknown | string |
The unknown. |
|
Direct, Email and Other
|
data.topReferrers.Direct, email and other | string |
The direct, email and other contacts. |
|
Chrome
|
data.topBrowsers.Chrome | string |
Chrome. |
|
Windows 10
|
data.topOs.Windows 10 | string |
Windows 10. |
|
Facebook
|
data.socialCount.facebook | integer |
Facebook. |
|
Twitter
|
data.socialCount.twitter | integer |
Twitter. |
|
Instagram
|
data.socialCount.instagram | integer |
Instagram. |
Get a single user
- Operation ID:
- UserGet
Get data for a single user.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
data.id | integer |
The unique identifier. |
|
Email
|
data.email | string |
The email address. |
|
Username
|
data.username | string |
The username. |
|
Avatar
|
data.avatar | string |
The avatar. |
|
Status
|
data.status | string |
The status. |
|
Plan ID
|
data.planid | integer |
The identifier of the plan. |
|
Expires
|
data.expires | string |
When expires. |
|
Registered
|
data.registered | string |
When registered. |
|
API Key
|
data.apikey | string |
The API key. |
Get account
- Operation ID:
- AccountGet
To get information on the account, you can send a request to this endpoint and it will return data on the account.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
data.id | integer |
The unique identifier. |
|
Email
|
data.email | string |
The email address. |
|
Username
|
data.username | string |
The username. |
|
Avatar
|
data.avatar | string |
The avatar. |
|
Status
|
data.status | string |
The status. |
|
Expires
|
data.expires | string |
When expires. |
|
Registered
|
data.registered | string |
When registered. |
List all branded domains
- Operation ID:
- DomainList
To get your branded domains codes via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit number. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | string |
The error code. |
|
Result
|
data.result | integer |
The result. |
|
Per Page
|
data.perpage | integer |
The number per page. |
|
Current Page
|
data.currentpage | integer |
The current page. |
|
Next Page
|
data.nextpage | integer |
The next page number. |
|
Max Page
|
data.maxpage | integer |
The maximum number per page. |
|
Domains
|
data.domains | array of object | |
|
ID
|
data.domains.id | integer |
The unique identifier. |
|
Domain
|
data.domains.domain | string |
The domain. |
|
Redirect Root
|
data.domains.redirectroot | string |
The redirect root. |
|
Redirect 404
|
data.domains.redirect404 | string |
The redirect 404. |
List all CTA overlays
- Operation ID:
- CTAList
To get call-to-action overlays via the API, you can use this endpoint
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit number. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Result
|
data.result | integer |
The result. |
|
Per Page
|
data.perpage | integer |
The number per page. |
|
Current Page
|
data.currentpage | integer |
The current page. |
|
Next Page
|
data.nextpage | integer |
The next page number. |
|
Max Page
|
data.maxpage | integer |
The maximum number per page. |
|
CtA
|
data.cta | array of object | |
|
ID
|
data.cta.id | integer |
The unique identifier. |
|
Type
|
data.cta.type | string |
The type. |
|
Name
|
data.cta.name | string |
The name. |
|
Date
|
data.cta.date | string |
The date. |
List all custom splash
- Operation ID:
- SplashList
To get custom splash pages via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit number. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Result
|
data.result | integer |
The result. |
|
Per Page
|
data.perpage | integer |
The number per page. |
|
Current Page
|
data.currentpage | integer |
The current page. |
|
Next Page
|
data.nextpage | integer |
The next page number. |
|
Max Page
|
data.maxpage | integer |
The maximum number per page. |
|
Splash
|
data.splash | array of object | |
|
ID
|
data.splash.id | integer |
The unique identifier. |
|
Name
|
data.splash.name | string |
The name. |
|
Date
|
data.splash.date | string |
The date. |
List all links
- Operation ID:
- LinkList
To get your links via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit number. |
|
|
Page
|
page | integer |
The page number. |
|
|
Order
|
order | string |
The order. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | string |
The error code. |
|
Result
|
data.result | integer |
The result. |
|
Per Page
|
data.perpage | integer |
The number per page. |
|
Current Page
|
data.currentpage | integer |
The current page. |
|
Next Page
|
data.nextpage | integer |
The next page number. |
|
Max Page
|
data.maxpage | integer |
The maximum number per page. |
|
URLs
|
data.urls | array of object | |
|
ID
|
data.urls.id | integer |
The unique identifier. |
|
Alias
|
data.urls.alias | string |
The alias. |
|
Short URL
|
data.urls.shorturl | string |
The short URL address. |
|
Long URL
|
data.urls.longurl | string |
The long URL address. |
|
Clicks
|
data.urls.clicks | integer |
The number of clicks. |
|
Title
|
data.urls.title | string |
The title. |
|
Description
|
data.urls.description | string |
The description. |
|
Date
|
data.urls.date | string |
The date. |
List all pixels
- Operation ID:
- PixelList
To get your pixels codes via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit number. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Result
|
data.result | integer |
The result. |
|
Per Page
|
data.perpage | integer |
The number per page. |
|
Current Page
|
data.currentpage | integer |
The current page. |
|
Next Page
|
data.nextpage | integer |
The next page number. |
|
Max Page
|
data.maxpage | integer |
The maximum number per page. |
|
Pixels
|
data.pixels | array of object | |
|
ID
|
data.pixels.id | integer |
The unique identifier. |
|
Type
|
data.pixels.type | string |
The type. |
|
Name
|
data.pixels.name | string |
The name. |
|
Tag
|
data.pixels.tag | string |
The tag. |
|
Date
|
data.pixels.date | string |
The date. |
List all plans
- Operation ID:
- PlanList
Get a list of all plans on the platform. This endpoint is only accessible by users with admin privileges.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Data
|
data | array of object | |
|
ID
|
data.id | integer |
The unique identifier. |
|
Name
|
data.name | string |
The name. |
|
Free
|
data.free | boolean |
Whether free. |
|
Prices
|
data.prices | string |
The prices. |
|
Links
|
data.limits.links | integer |
The links. |
|
Clicks
|
data.limits.clicks | integer |
The number of clicks. |
|
Retention
|
data.limits.retention | integer |
The number of retention. |
|
Enabled
|
data.limits.custom.enabled | string |
If enabled. |
|
Enabled
|
data.limits.team.enabled | string |
If enabled. |
|
Count
|
data.limits.team.count | string |
The count. |
|
Enabled
|
data.limits.splash.enabled | string |
If enabled. |
|
Count
|
data.limits.splash.count | string |
The count. |
|
Enabled
|
data.limits.overlay.enabled | string |
If enabled. |
|
Count
|
data.limits.overlay.count | string |
The count. |
|
Enabled
|
data.limits.pixels.enabled | string |
If enabled. |
|
Count
|
data.limits.pixels.count | string |
The count. |
|
Enabled
|
data.limits.domain.enabled | string |
If enabled. |
|
Count
|
data.limits.domain.count | string |
The count. |
|
Enabled
|
data.limits.multiple.enabled | string |
If enabled. |
|
Enabled
|
data.limits.alias.enabled | string |
If enabled. |
|
Enabled
|
data.limits.device.enabled | string |
If enabled. |
|
Enabled
|
data.limits.geo.enabled | string |
If enabled. |
|
Enabled
|
data.limits.bundle.enabled | string |
If enabled. |
|
Enabled
|
data.limits.parameters.enabled | string |
If enabled. |
|
Enabled
|
data.limits.export.enabled | string |
If enabled. |
|
Enabled
|
data.limits.api.enabled | string |
If enabled. |
List all QR codes
- Operation ID:
- QRList
To get your QR codes via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit number. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Result
|
data.result | integer |
The result. |
|
Per Page
|
data.perpage | integer |
The number per page. |
|
Current Page
|
data.currentpage | integer |
The current page. |
|
Next Page
|
data.nextpage | integer |
The next page number. |
|
Max Page
|
data.maxpage | integer |
The maximum number per page. |
|
QRs
|
data.qrs | array of object | |
|
ID
|
data.qrs.id | integer |
The unique identifier. |
|
Link
|
data.qrs.link | string |
The link. |
|
Scans
|
data.qrs.scans | integer |
The number of scans. |
|
Name
|
data.qrs.name | string |
The name. |
|
Date
|
data.qrs.date | string |
The date. |
List all users
- Operation ID:
- UserList
Get a list of all users on the platform. This endpoint is only accessible by users with admin privileges.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter
|
filter | string |
The filter. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Data
|
data | array of object | |
|
ID
|
data.id | integer |
The unique identifier. |
|
Email
|
data.email | string |
The email address. |
|
Username
|
data.username | string |
The username. |
|
Avatar
|
data.avatar | string |
The avatar. |
|
Status
|
data.status | string |
The status. |
|
Plan ID
|
data.planid | integer |
The identifier of the plan. |
|
Expires
|
data.expires | string |
When expires. |
|
Registered
|
data.registered | string |
When registered. |
|
API Key
|
data.apikey | string |
The API key. |
Shorten a link
- Operation ID:
- LinkShorten
To shorten a single link via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
The URL address. |
|
Custom
|
custom | string |
The custom link. |
|
|
Password
|
password | string |
The password. |
|
|
Expiry
|
expiry | string |
The expiration date. |
|
|
Type
|
type | string |
The type. |
|
|
Location
|
location | string |
The location. |
|
|
Link
|
link | string |
The link. |
|
|
Device
|
device | string |
The device. |
|
|
Link
|
link | string |
The link. |
|
|
Name
|
name | string |
The name. |
|
|
Value
|
value | string |
The value. |
|
|
Device
|
device | string |
The device. |
|
|
Link
|
link | string |
The link. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
id | integer |
The unique identifier. |
|
Short URL
|
shorturl | string |
The short URL address. |
Subscribe a user to a plan
- Operation ID:
- PlanSubscribe
To subscribe a user to plan, send a PUT request to this endpoint with the plan id and user id. The type of subscription and the expiration date will need to be specified. If the expiration date is not specified, the date will be adjusted according to the type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Plan ID
|
planid | True | string |
The identifier of the plan. |
|
User ID
|
userid | True | string |
The identifier of the user. |
|
Type
|
type | string |
The type. |
|
|
Expiration
|
expiration | string |
The expiration date. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Update a domain
- Operation ID:
- DomainUpdate
A branded domain can be updated using this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
|
Redirect Root
|
redirectroot | string |
The redirect root. |
|
|
Redirect 404
|
redirect404 | string |
The redirect 404. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Update a link
- Operation ID:
- LinkUpdate
To update a link via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
|
URL
|
url | string |
The URL address. |
|
|
Custom
|
custom | string |
The custom link. |
|
|
Password
|
password | string |
The password. |
|
|
Expiry
|
expiry | string |
The expiration date. |
|
|
Type
|
type | string |
The type. |
|
|
Location
|
location | string |
The location. |
|
|
Link
|
link | string |
The link. |
|
|
Device
|
device | string |
The device. |
|
|
Link
|
link | string |
The link. |
|
|
Name
|
name | string |
The name. |
|
|
Value
|
value | string |
The value. |
|
|
Device
|
device | string |
The device. |
|
|
Link
|
link | string |
The link. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
ID
|
id | integer |
The unique identifier. |
|
Short
|
short | string |
The short URL. |
Update a pixel
- Operation ID:
- PixelUpdate
To update a pixel via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
|
Name
|
name | string |
The name. |
|
|
Tag
|
tag | True | string |
The tag. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Update a QR code
- Operation ID:
- QRUpdate
To update a single QR code via the API, you can use this endpoint.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The unique identifier. |
|
Type
|
type | string |
The type. |
|
|
Data
|
data | True | string |
The data. |
|
Background
|
background | string |
The background. |
|
|
Foreground
|
foreground | string |
The foreground. |
|
|
Logo
|
logo | string |
The logo. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |
Update account
- Operation ID:
- AccountUpdate
To update information on the account, you can send a request to this endpoint and it will update data on the account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Email
|
string |
The email address. |
||
|
Password
|
password | string |
The password. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Error
|
error | integer |
The error code. |
|
Message
|
message | string |
The response message. |