Transfers

Submits a Draft standalone transfer (the Details page's "Submit Transfer"): it becomes Pending.

Requires ManageTransfers and an Idempotency-Key header; no body. Only a standalone transfer in Draft (transfers created by POST /api/v1/transfers are already Pending). The approval rule of a new transfer applies: when its value reaches the organization's threshold an approval is requested (approvalStatus``Pending, managers are emailed) and only approve / reject apply until it is decided.

post/api/v1/transfers/{id}/submit

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/transfers/{id}/submit
  • Auth: HTTP bearer

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

Response

Transfer id and confirmation message (e.g. Transfer submitted. Pick its lines, then start it.).

idinteger

Id of the resource the operation acted on (e.g. the job id).

messagestring nullable

Human-readable confirmation from the service (e.g. "Job started."). May be null.

warningstring nullable

Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

Changes

No recorded changes to this operation across all 1 revision of this API.