Update import run
Updates import run for the authorised account.
PATCH
/api/v1/import/runs/{runId}import: 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.
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
runId | string (uuid) | Required | Identifier of the run. |
Request body
application/json · required
| Name | Type | Required | Description |
|---|---|---|---|
status | string | Optional | Status. Allowed values: "running", "completed", "failed". |
summary | object | Optional | Summary. |
summary.directories | object | Required | Directories. |
summary.directories.created | number | Required | Created. |
summary.directories.skipped | number | Required | Skipped. |
summary.directories.failed | number | Required | Failed. |
summary.directories.updated | number | Optional | Updated. |
summary.members | object | Required | Members. |
summary.members.created | number | Required | Created. |
summary.members.skipped | number | Required | Skipped. |
summary.members.failed | number | Required | Failed. |
summary.members.updated | number | Optional | Updated. |
summary.entries | object | Required | Entries. |
summary.entries.created | number | Required | Created. |
summary.entries.skipped | number | Required | Skipped. |
summary.entries.failed | number | Required | Failed. |
summary.entries.updated | number | Optional | Updated. |
summary.frontSessions | object | Required | Front Sessions. |
summary.frontSessions.created | number | Required | Created. |
summary.frontSessions.skipped | number | Required | Skipped. |
summary.frontSessions.failed | number | Required | Failed. |
summary.frontSessions.updated | number | Optional | Updated. |
finishedAt | number | Optional | Finished At. |
errorMessage | string | Optional | Error Message. |
progressPhase | string | Optional | Progress Phase. |
progressPercent | number | Optional | Progress Percent. |
progressDetail | string | Optional | Progress Detail. |
Response schema
204
Successful operation. No response body.
Errors
400· JSON errorRequest failed (BAD_REQUEST).
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires import: read_write; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
409· JSON errorRequest failed (CONFLICT).
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
503· JSON errorPostgreSQL is not configured (DATABASE_URL).
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request PATCH 'https://floralitys.com/api/v1/import/runs/11111111-1111-4111-8111-111111111111' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"status": "running"
}'Responses
Successful operation. No response body.
No response body.
Example values are illustrative demo data.