Link Group Creation API

Create link groups to manage short links more efficiently at scale.

Organize links by category, apply settings in bulk, and maintain a clean, structured setup.

Apply shared settings such as expiration, password protection, webhooks, and click limits across multiple links.

If both individual and group settings are set, group settings take precedence.

POST

/api/link-group/v1/create 

{
    "nm": "Youtube Group",
    "memo": "A group of links included in the description section of a YouTube video.",
    "nonmemberSticsPwd": "123456"
}

Request Parameters

nm string required
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. (0 means 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 when webhookEnableYn is Y. 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": {
        "grpIdx": 5066,  // group idx
        "webhookSecretKey": null  // When the ‘webhookEnableYn’ parameter is set to ‘Y’, a secret key is specified.
    }
}

Response Parameters

codeinteger
Response code: 0 = Success, any other value = Error
messagestring
Response message. If the response code is not 0, an error-related message is returned.
resultobject
grpIdx integer
Group IDX.
webhookSecretKey string
The secret key is returned when webhookEnableYn is set to Y.

When to Use This API

Use this API when you need a smarter way to organize and manage multiple short links at scale.

  • Group links by category for cleaner organization
  • Separate links by campaign for clearer performance tracking
  • Organize links by user or project
  • Apply settings to multiple links in one go
Managing links as groups keeps everything structured and easy to scale.

What is the role of a link group?

A link group lets you manage multiple short links as one, keeping your structure clean and easy to control.

  • Organize and manage links by group
  • Apply shared settings like notifications and access controls
  • Segment analytics and reporting
  • Streamline operations
A must-have feature for managing links efficiently at scale.

Use cases

This API fits a wide range of real-world scenarios.

  • Event pages: Limit access to a specific time window using strtYmdt·endYmdt
  • Internal links: Restrict access with a password using pwd
  • Webhook-enabled links: Get instant server notifications on clicks via webhookCallbackUrl
  • More: Organize links by product category or by customer and team
As your link volume grows, management becomes significantly more efficient.

Things to consider

Check the following before creating a link group.

  • Use clear, descriptive names that reflect your management purpose
  • Group settings can impact all links within the group
  • Misconfigurations may affect operations, so apply changes with care
  • Use the Link Group Update API to make changes when needed
A clear group structure is essential for efficient link management at scale.