Refresh link preview
Refresh Link Preview using the API key’s account.
POST
/api/v1/messaging/link-previews/{previewId}/refreshmessaging: read_write1,000 requests/minute/key · all plansActive API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.
Message storage
Message text is encrypted at rest and decrypted for authorised requests. Channel access is restricted to spaces owned by the API key’s account; missing or inaccessible channels return 404. Editing or deleting a message additionally checks its author and can return 403.
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
previewId | string (uuid) | Required | Identifier of the preview. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier. |
spaceId | string | Required | Space Id. |
channelId | string | Required | Channel Id. |
messageId | string | Required | Message Id. |
url | string | Required | Url. |
canonicalUrl | null | string | Required | Canonical Url. |
finalUrl | null | string | Required | Final Url. |
domain | string | Required | Domain. |
siteName | null | string | Required | Site Name. |
title | null | string | Required | Display title. |
description | null | string | Required | Description of the resource. |
imageUrl | null | string | Required | Image Url. |
imageWidth | null | number | Required | Image Width. |
imageHeight | null | number | Required | Image Height. |
faviconUrl | null | string | Required | Favicon Url. |
providerName | null | string | Required | Provider Name. |
status | string | Required | Status. Allowed values: "pending", "blocked", "success", "failed", "dismissed". |
errorCode | null | string | Required | Error Code. |
contentType | null | string | Required | Content Type. |
httpStatus | null | number | Required | Http Status. |
previewOrder | number | Required | Preview Order. |
fetchedAt | null | number | Required | Fetched At. |
createdAt | number | Required | Creation time. |
updatedAt | number | Required | Most recent update time. |
Errors
400· JSON errorRequest failed (BAD_REQUEST).
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires messaging: read_write; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
409· JSON errorconflict.
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
500· JSON errorinternal server error.
503· JSON errorObject storage is not configured. Set MinIO (or compatible S3) env vars to upload files.
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request POST 'https://floralitys.com/api/v1/messaging/link-previews/11111111-1111-4111-8111-111111111111/refresh' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
{
"id": "11111111-1111-4111-8111-111111111111",
"spaceId": "11111111-1111-4111-8111-111111111111",
"channelId": "11111111-1111-4111-8111-111111111111",
"messageId": "11111111-1111-4111-8111-111111111111",
"url": "https://example.com/demo",
"canonicalUrl": null,
"finalUrl": null,
"domain": "demo",
"siteName": null,
"title": null,
"description": null,
"imageUrl": null,
"imageWidth": null,
"imageHeight": null,
"faviconUrl": null,
"providerName": null,
"status": "pending",
"errorCode": null,
"contentType": null,
"httpStatus": null,
"previewOrder": 0,
"fetchedAt": null,
"createdAt": 1767225600000,
"updatedAt": 1767225600000
}Example values are illustrative demo data.