Pin message
Pin Message using the API key’s account.
POST
/api/v1/messaging/channels/{channelId}/pinsmessaging: 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 |
|---|---|---|---|
channelId | string (uuid) | Required | Identifier of the channel. |
Request body
application/json · required
Unknown properties are rejected.
| Name | Type | Required | Description |
|---|---|---|---|
messageId | string (uuid) | Required | Message Id. |
Response schema
201
Created.
| Name | Type | Required | Description |
|---|---|---|---|
pinId | string | Required | Pin Id. |
messageId | string | Required | Message Id. |
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/channels/11111111-1111-4111-8111-111111111111/pins' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"messageId": "11111111-1111-4111-8111-111111111111"
}'Responses
Created.
{
"pinId": "11111111-1111-4111-8111-111111111111",
"messageId": "11111111-1111-4111-8111-111111111111"
}Example values are illustrative demo data.