Create short links
Creates shortened versions of one or more URLs
path Parameters
| SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
Request Body schema: application/jsonrequired
The long links to shorten
The short urls that were created or failed to be created
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- Payload
- curl
- Ruby
- C#
- Node.js
[- {
- "ClickTrackingEnabled": false,
- "Expiration": "P90D",
- "Alias": "string",
}
]- 200
- 400
- 401
- 403
- 404
- 409
- 412
- 422
- 429
- 4XX
- 5XX
{- "Succeeded": [
- {
- "LinkSlug": "s8n6EzC",
- "ClickTrackingEnabled": false,
- "SlidingExpiration": "P90D",
- "Expiration": "2024-10-01T04:31:15.5463482+00:00",
- "Alias": "string",
- "Visits": 0,
}
], - "Failed": [
- {
- "Error": {
- "title": "Bad Request",
- "status": 400,
- "detail": "Missing required field 'address'",
- "instance": "/api/v1/physical-post/letters",
- "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}
}
]
}List Shortened Links
Lists active short links for the site
path Parameters
| SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
query Parameters
The shortened urls for this site which passed the supplied filters
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- curl
- Ruby
- C#
- Node.js
- 200
- 400
- 401
- 403
- 404
- 409
- 412
- 422
- 429
- 4XX
- 5XX
{- "Items": [
- {
- "LinkSlug": "s8n6EzC",
- "ClickTrackingEnabled": false,
- "SlidingExpiration": "P90D",
- "Expiration": "2024-10-01T04:31:15.5463482+00:00",
- "Alias": "string",
- "Visits": 0,
}
], - "NextPageToken": "eyJ0eXAiOi"
}Get Shortened Link
Gets the details of a shortened link by ID
The shortened link's details
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- curl
- Ruby
- C#
- Node.js
- 200
- 400
- 401
- 403
- 404
- 409
- 412
- 422
- 429
- 4XX
- 5XX
{- "LinkSlug": "s8n6EzC",
- "ClickTrackingEnabled": false,
- "SlidingExpiration": "P90D",
- "Expiration": "2024-10-01T04:31:15.5463482+00:00",
- "Alias": "string",
- "Visits": 0,
}Delete Shortened Link
Deletes a shortened link by ID
The link was deleted, or did not exist
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- curl
- Ruby
- C#
- Node.js
- 400
- 401
- 403
- 404
- 409
- 412
- 422
- 429
- 4XX
- 5XX
{- "title": "The Name field is required.",
- "detail": "The Name field is required.",
- "status": 400,
- "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}