post https://api.repsly.com/v3/import/schedule
Endpoint is used to import schedules from your system into Repsly.
Request definition
Required keys are marked with a red triangle 🔺
| Name | Type | Description |
|---|---|---|
| ScheduleCode | String (50) | Unique schedule identifier, if empty it will be generated |
| ClientCode 🔺 | String (50) | Place (client) code that will be assigned to this schedule |
| UserID🔺 | String (20) | Representative code that will be assigned to this schedule |
| ScheduledDate🔺 | String (10) | Date when schedule begins (date format "2024-11-25") |
| RepeatEveryWeeks🔺 | Integer | Interval for weekly schedule recurrence. 0 for non recurring schedule |
| DueDate | Boolean | Indicates if visit has a due date or not |
| RepeatEndDate | String (10) | End date for repeating recurring schedules (date format "2024-11-25") |
| RepeatDays | String (60) | Days on which recurring scheduled visits occur (format "Sunday|Monday|Friday") |
| ScheduledTime | String (5) | Time of visit (time format "15:00"), empty for any time visit |
| ScheduledDuration | Integer | Duration of the visit in minutes, if empty default to 30 minutes |
| VisitNote | Text | Note on the visit |
| AlertUsersIfMissed | String | List of admin emails that will be notified if scheduled visit was missed (format "admin_email_1|admin_email_2") |
| AlertUsersIfLate | String | List of admin emails that will be notified if visitor was late (format "admin_email_1|admin_email_2") |
| AlertUsersIfDone | String | List of admin emails that will be notified if scheduled visit was completed (format "admin_email_1|admin_email_2") |
| ExternalID | String | Optional external identifier |
| Active | Boolean | If empty or "true" schedule will be active after import, if "false" that schedule will be deleted. |
| Tasks | Array(Task) | List of tasks that need to be completed during scheduled visit, definition is below |
Tasks array definition
| Name | Type | Description |
|---|---|---|
| TaskType 🔺 | String | Task type identifier, possible values are "Note", "Photo", "Form", "Audit" or "Sales document" |
| TaskDescription 🔺 | String | Custom description for Photo or Note. Form, Audit and Sales document require their exact title as description |
Response definition
| Name | Type | Description |
|---|---|---|
| Code | Integer | Error identifier (0 = no errors) |
| Message | String (255) | Response affirmative or error message. Message will include ImportJobID which can be used to check current status of requested import. |
In case of a HTTP bad request (code 400), you will also receive a status response with Code not equal to 0 and an error message.