Create Shortlink

Method: POST

Endpoint: https://api.webexinteract.com/assets/v1/shortlink

Rate Limit: 10 transactions per second.

Parameters

Parameter Name	Type	Mandatory	Example values	Description
title	String	Yes	Webex Interact Website	Fuzzy search on text found in a short link name or tags.
target_url	String	Yes	https://webexinteract.com/use-cases/retail	Exact match search on tags.
tags	Array of Strings	No	tagexample	Add tags
track_clicks	Boolean	No	true, false	Date format: ISO 8601 date-time format with UTC timezone indicated by 'Z' suffix

Sample request

{
  "title": "Webex Interact Website",
  "target_url": "https://webexinteract.com/use-cases/retail",
  "tags": [
    "Usecases",
    "Retail"
  ],
  "track_clicks": false
}

Sample response

{
  "title": "Webex Interact Website- Retail Usecase",
  "link_id": "shl_33n2I2tiKU3ISIXKtZcbS8f4uAd",
  "target_url": "https://webexinteract.com/use-cases/retail",
  "short_link_url": "https://sh.l.imireach.net/lAa",
  "tags": [
    "Usecases",
    "Retail"
  ],
  "created_at": "2025-10-08T21:17:12Z",
  "track_clicks": false
}

{
  "trace_id": "cafc8acb8587b77f",
  "code": "ERR_AST_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-10-24T09:30:45.075326154Z",
  "validation_errors": [
    {
      "field": "tags[]",
      "message": "Invalid tag.",
      "rejected_value": "tag-01234567890123456789123456789"
    }
  ]
}

Retrieve a specific shortlink

Method: GET

Endpoint: https://api.webexinteract.com/assets/v1/shortlink/<Link ID>

Rate Limit: 10 transactions per second.

Parameters

Parameter name	Type	Mandatory	Example Values	Description
Link ID	string	Yes	`shl_393RQ5L8U1YZpPdrJPUImK2Gdng`	Pass a short lnk ID to return information about it

Sample request

GET https://api.webexinteract.com/assets/v1/shortlink/shl_393RQ5L8U1YZpPdrJPUImK2Gdng

Sample response

{
  "title": "Webex Interact Website- Retail Usecase",
  "link_id": "shl_393RQ5L8U1YZpPdrJPUImK2Gdng",
  "target_url": "https://webexinteract.com/use-cases/retail",
  "short_link_url": "https://sh.l.imireach.net/HoaB98",
  "tags": [
    "Usecases",
    "Retail"
  ],
  "created_at": "2025-10-14T11:10:50Z",
  "track_clicks": true
}

{
  "trace_id": "da016c7952e0d910",
  "code": "ERR_AST_NF_003",
  "error": "RESOURCE_NOT_FOUND",
  "message": "Short link with identifier 'shl_343RQ5L8U1YJpPdrJPUImK2Gdna' not found",
  "status": 404,
  "timestamp": "2025-10-15T13:16:02.190564392Z"
}

Retrieve and filter multiple short links

Method: POST

Endpoint: https://api.webexinteract.com/assets/v1/shortlink/filter

Rate Limit: 10 transactions per second.

Parameters

Parameter Name	Type	Mandatory	Example values	Description
query	String	No	Feedback	Fuzzy search on text found in a short link name or tags.
tags	Array of strings	No	tag-1	Exact match search on tags.
created_at_start	Date String	No	2025-10-07T12:10:50Z	Filter on short links created after a specified date. Date format: ISO 8601 date-time format with UTC timezone indicated by 'Z' suffix
created_at_end	Date String	No	2025-10-07T12:10:50Z	Date format: ISO 8601 date-time format with UTC timezone indicated by 'Z' suffix
sort_order	String	No	DESC, ASC	Order results by created_at. Defaults to DESC.
page_number	Integer	No	1	Specify the page number to return. Defaults to 1.
page_size	Integer	No	20	Specify the page size. Defaults to 25.

Sample request

{
  "filter" : {
    "query" : "Feedback", 
    "tags" : ["tag-1", "tag-2"],
    "created_at_start" : "2025-10-07T12:10:50Z", 
    "created_at_end" : "2026-10-07T12:11:59Z"
  },
  "sort": {
    "sort_by": "created_at",
    "sort_order": "DESC"
  }, 
  "page" : {
    "page_number" : 1, 
    "page_size" : 1
  }
}

Sample response

{
  "paging": {
    "current_page": 1,
    "total_items": 1,
    "total_pages": 5
  },
  "items": [
    {
      "title": "Feedback Form Link",
      "link_id": "shl_33n8uU7jy1PQCusVTw9yq3gyav3",
      "target_url": "http://imimobile.atlassian.net/browse/RCH-*",
      "short_link_url": "https://sh.l.imireach.net/mUF",
      "tags": [
        "tag-0tag-0tag-0tag",
        "tag-1"
      ],
      "created_at": "2025-10-08T16:41:37Z",
      "track_clicks": false
    }
  ]
}

{
  "trace_id": "842c2c9bab450d70",
  "code": "ERR_AST_VAL_001",
  "error": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 400,
  "timestamp": "2025-10-24T09:59:18.537761005Z",
  "validation_errors": [
    {
      "field": "sort.sort_order",
      "message": "Sort Order must be ASC or DESC",
      "rejected_value": "DESCa"
    }
  ]
}

Delete a shortlink

Method: DELETE

Endpoint: https://api.webexinteract.com/assets/v1/shortlink/<Link_ID>

Rate Limit: 10 transactions per second.

Parameters

This endpoint requires no additional parameters.

Sample request

DELETE https://api.webexinteract.com/assets/v1/shortlink/shl_393RQ5L8U1YZpPdrJPUImK2Gdng

Sample responses

HTTP/1.1 204 No Content

{
  "trace_id": "38aif88c9bf38014",
  "code": "ERR_AST_VAL_001",
  "error": "INVALID_UID_FORMAT",
  "message": "Invalid UID format: 'a'. UIDs must follow the specified format.",
  "status": 400,
  "timestamp": "2025-10-24T10:00:59.563289168Z",
  "validation_errors": [
    {
      "field": "delete_short_link_by_id.id",
      "message": "UID is invalid",
      "rejected_value": "a"
    }
  ]
}

Error Codes

Code	Error	Message
ERR_AST_VAL_001	VALIDATION_FAILED	Request validation failed
ERR_AST_NF_003	RESOURCE_NOT_FOUND	Requested resource not found
ERR_AST_SYS_001	INTERNAL_SERVER_ERROR	Internal server error occurred
ERR_AST_AUTH_002	FORBIDDEN	Access denied
ERR_AST_GEN_001	GENERIC_ERROR	An error occurred
ERR_AST_REQ_001	MISSING_PARAMETER	Required parameter is missing
ERR_AST_VAL_004	INVALID_PARAMETER_TYPE	Invalid parameter type provided
ERR_AST_REQ_002	INVALID_REQUEST_BODY	Invalid or malformed request body