Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Sync a Model

This request creates a Sync request for a specific model.

Request URL

Syntax POST /restapi/models/sync/{foliooid}
Example URL

Request Data Fields

No request data fields should be provided.

Request Example

POST /restapi/models/sync/1234567890123 HTTP/1.1
Content-Type: application/json

Response Example

Returns the model's folioOid upon a successful placement of a Sync request.

HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Content-Type: application/json
Date: Fri, 23 Oct 2015 20:15:08 GMT


Error Codes

The following error codes may be returned.

Error code Explanation Open orders exist for the Model Folio.
model.sync.failed.nontradeable.securities The order contained Non-tradeable securities.
model.sync.failed.order.generation.error An error occurred during order generation.
model.sync.failed.corp.actions.exist There are corporate actions in progress for at least one security in the Model Folio. No orders were generated for the Sync request. No buy or sell orders were generated for the Sync request. A trade was not allowed.
model.sync.failed.sell.securities.rule A security sell rule was violated. Not enough cash was in the account for buy orders. Mutual fund minimum rule violated.
model.sync.failed.create.order.from.model An error occurred while generating orders. An error occurred while posting Folio order. An error occurred while placing the Sync request.


The request is made using the folioOid of the model, and only the member who created the model can sync the model.

Change Log


  1. Clarified Request URL Syntax
  2. Added Notes

Getting Started