Link Group Update API
Update multiple short links at once by managing them as a group.
Adjust settings at the group level to control campaigns more efficiently, and update shared options like expiration, password protection, and webhooks in one step.
When group settings change, the updates apply to all links within the group.
If both individual and group settings exist, group settings take precedence.
PUT
/api/link-group/v1/update
{
"grpIdx": 5066,
"nm": "Instagram Group",
"memo": "A group of links used in Instagram ads.",
"strtYmdt": "2026-03-01 00:00:00",
"endYmdt": "2026-03-31 23:59:59",
"expireUrl": "https://example.com/event-expired"
}
Request Parameters
- grpIdx integer required
-
Group IDX.
Specify the IDX of the group you want to update. - nm string
-
Group name.
Set the name of the group used to organize and manage links. - memo string
-
Memo for managing the group.
You can freely record the purpose of the group or management notes. - notfSubscYn string
- Default:N
-
Enum:
YN
-
Sets whether the link is a push subscription link.
Y: Creates a push subscription–only link, N: Creates a normal link.
When a user accesses a push subscription link, a web push notification subscription request will appear. - qrBypassYn string
- Default:N
-
Enum:
YN
-
Sets the redirect behavior when accessing via a QR code.
Y: Redirects directly to the original URL. (Click statistics are not recorded)
N: Redirects to the short link URL. (Click statistics are recorded) - blockOverseasSticsYn string
- Default:N
-
Enum:
YN
-
Sets whether to exclude overseas access statistics.
Y: Overseas access is excluded from statistics.
N: Access from all countries is included in statistics. - pushNotifyYn string
- Default:N
-
Enum:
YN
-
Sets whether push notifications for click counts are enabled.
Y: A push notification is sent when the defined threshold is reached.
N: No push notification is sent.
This feature is available starting from the Personal plan. - mailNotifyYn string
- Default:N
-
Enum:
YN
-
Sets whether email notifications for click counts are enabled.
Y: An email notification is sent when the defined threshold is reached.
N: No email notification is sent.
This feature is available starting from the Personal plan. - nonmemberSticsPwd string
-
Password for viewing click statistics as a non-member.
If you want to allow non-members to view click statistics, set the password required to access the statistics page. - strtYmdt datetime
-
Link validity start date.
The link can be accessed after the specified date.
Example:2026-03-01 00:00:00 - endYmdt datetime
-
Link expiration date.
Access to the link will be blocked after the specified date.
Example:2026-03-31 23:59:59 - expireUrl string
-
URL to redirect to after the link expires.
If not set, a default notification page will be displayed.
Example:https://example.com/event-expired - pwd string
-
Password required to access the link.
If set, users must enter the password before accessing the destination page. - acesMaxCnt integer
-
Maximum allowed click count.
If the defined limit is exceeded, access to the link is blocked. (0means unlimited) - webhookEnableYn string
- Default:N
-
Enum:
YN
-
Whether Webhook is enabled.
Global Webhook must be activated.
This feature is available only on the Enterprise plan. - webhookCallbackUrl string
-
Server URL that receives Webhook events.
Required whenwebhookEnableYnisY. Enter the endpoint on your server that receives event data.
Example:https://api.example.com/webhook - webhookMetric string
- Default:C
-
Enum:
CP
-
Webhook trigger metric.
C: Based on click count, P: Based on unique users (unique clicks) - webhookFrequency integer
- Default:1
-
Enum:
1501002003005001000
-
Webhook trigger frequency.
1: Every click, 50: Every 50 clicks, 100: Every 100 clicks, 300: Every 300 clicks, 500: Every 500 clicks, 1000: Every 1,000 clicks
{
"code": 0,
"message": "",
"result": null // When the ‘webhookEnableYn’ parameter is set to ‘Y’, a secret key is specified.
}
Response Parameters
- code integer
- Response code: 0 = Success, other values = Error
- message string
- Response message. If the response code is not 0, an error message is returned.
- result string
-
webhookEnableYnis set toY, a secret key is generated and returned.
If awebhookSecretKeyalready exists for the group, a new key will not be generated or returned.
When to Use This API
Use this API when managing short links individually becomes inefficient.
- Disable multiple campaign links at once or update their active period
- Restrict access to all links after a specific event ends
- Apply the same settings across multiple links in one step
Key Features and Configuration Impact
This API goes beyond simple updates and defines how your link operations behave.
Access control
- Restrict access for non-registered users
- Limit QR code access → allow only selected users
Analytics and filtering
- Exclude bot traffic → directly improves data accuracy
Notifications
- Push and email alerts → respond to link events in real time
Scheduling
- Set start and end dates → automatic activation and deactivation
Expiration handling
- Redirect after expiration → maintain a smooth user experience
Webhooks
- Send event data to external servers → enable integrations and automation
Use cases
- Marketing campaigns: Disable all links at once when a campaign ends and automatically redirect to an expiration URL
- SaaS platforms: Group links by feature and centrally manage access and availability
- High-volume link management: Use webhooks to sync click events with internal systems in real time
- Security: Maintain security by rotating passwords regularly
Things to consider
- Changes to group settings apply instantly to all links
- Incorrect date settings may restrict access to all links
- Webhook delivery may be delayed depending on external server availability
- Updating analytics filters can change how existing data is interpreted