Import data
Bring shifts, shift notes and client notes in from another system, and undo an import.
The import endpoints are for moving history or a batch of records from another system. They are built to be run safely: you can check first and undo after.
| What | Endpoint | Per call | Undo |
|---|---|---|---|
| Shifts | POST /shifts/import | 100 rows, merged into at most 50 shifts | DELETE /shifts/import/{batch} |
| Shift notes | POST /shift-notes/import | 100 notes | DELETE /shift-notes/import/{batch} |
| Client notes | POST /client-notes/import | 100 notes | DELETE /client-notes/import/{batch} |
Token permissions: Read-write on the area (Roster for shifts, Clients for client notes).
The routine
Dry run
Send the batch with dry_run set. Nothing is saved. Read the result for each row and fix problems.
Import
Send the same batch without dry_run. A batch imports all or nothing.
Keep the batch id
The response has a batch id. Store it. If something is wrong you can undo the whole batch.
Undo if needed
Call the matching DELETE with the batch id. It removes what that batch created.
Good to know
- Shifts or notes that already exist are skipped, so you can send a batch again safely.
- In a shift import, rows with the same clients, times and site become one multi-staff shift. A row with no staff becomes a shift pool shift.
- Shift notes are matched to a published shift by client, worker and shift time.
- Client notes can have backdated times and authors.
Import a small batch first, check it in Imploy, then do the rest. Undo only removes what a single batch created.