api.jobs.change_agent

POST /job/{jobDisplayId}/changeAgent — ACPortal

Python

api.jobs.change_agent(job_display_id: int, *, data: ChangeJobAgentRequest | dict) -> ServiceBaseResponse

CLI

ab jobs change_agent <job_display_id> [--data ...]

POST /job/{jobDisplayId}/changeAgent.

Args: job_display_id: Job display ID. data: Agent change payload with service type, agent ID, and optional price/rebate flags. Accepts a :class:ChangeJobAgentRequest instance or a dict.

Returns: :class:~ab.api.models.shared.ServiceBaseResponse

Request model: :class:ChangeJobAgentRequest

Request body — ChangeJobAgentRequest

Field	Type	Required	Description
serviceType	Optional[int]	no	Agent service type (0-4)
agentId	Optional[str]	no	Agent company UUID
recalculatePrice	Optional[bool]	no	Recalculate job price after change
applyRebate	Optional[bool]	no	Apply rebate after change

Response

Returns ServiceBaseResponse.

Field	Type	Required	Description
success	Optional[bool]	no	Whether the operation succeeded
errorMessage	Optional[str]	no	Error detail when success is False
jobSubManagementStatus	Optional[dict]	no	Current job sub-management status
documents	Optional[list[str]]	no	Document URLs/references generated by operation
errors	Optional[dict]	no	Detailed error object when success is False
confirmRequired	Optional[bool]	no	Whether user confirmation is needed
notifications	Optional[list[str]]	no	Notification messages for user
shipmentId	Optional[str]	no	Shipment UUID created or modified
shipmentAcceptIdentifier	Optional[str]	no	Carrier acceptance reference
weight	Optional[ShipmentWeight]	no	Shipment weight details
totalNetChargeAmount	Optional[float]	no	Total net charge amount
currencyCode	Optional[str]	no	Currency code (e.g., USD)
internationalInfoRequired	Optional[bool]	no	Whether international info is needed
shipOutDateRequired	Optional[bool]	no	Whether ship-out date confirmation is needed
fedExExpressFreightDetailRequired	Optional[bool]	no	Whether FedEx Express freight details are required
carrierAPI	Optional[int]	no	Carrier API type code

---

← Back to api.jobs