API Reference
Create Visit
Creates a visit.
To see an example workflow, read Creating Your First Axle Visit.
By default, this endpoint validates the time and clinicians you have provided. This includes making sure the clinicians are Eligible to do the visit, Available at the chosen time, and that the time falls within the Service Area’s operating hours, and so on.
If you want to skip this validation, you can use the skip_everything
parameter to force the creation of the visit anyway. In the future, we may introduce fine-grained control over which validation rules are skipped; for now, we have the skip_everything
parameter to skip all validation rules.
POST
Body
application/json
Response
201 - application/json
Visit created successfully
The response is of type object
.