Transfers

Rejects a transfer that is awaiting approval (Pending Approvals → Reject).

Requires ManageTransfers and an Idempotency-Key header. Body: { "reason": "Van 2 is out of service this week." } — the reason is required. Only a transfer whose approvalStatus is Pending and whose status is still Pending or Draft can be rejected. The transfer is cancelled, the reason is stored as rejectionReason and the requester is emailed.

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

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

Request body

reasonstring required

Why the transfer is rejected (required, 1–1000 characters). Stored on the approval and emailed to the person who requested it. Example: Van 2 is out of service this week.

Response

Transfer id and confirmation message (Transfer rejected.).

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.