Transfers

Approves a transfer that is awaiting approval (Pending Approvals → Approve).

Requires ManageTransfers and an Idempotency-Key header; no body. Only a transfer whose approvalStatus is Pending and whose status is still Pending or Draft can be approved (list them with ?approvalStatus=Pending&status=Pending) — standalone transfers whose value exceeded the organization's approval threshold; job-site transfers never need approval. The transfer moves to InTransit and the requester is emailed.

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

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

Response

Transfer id and confirmation message (Transfer approved.).

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.