Account

Pause, resume or edit a standing order

Requires the order scope. Omitted fields are left alone; anchor_plan, if_no_content and content_mode accept null to clear.

patch/v1/standing_orders/{id}

Request

  • Base URL: https://api.placementapi.com
  • URL: https://api.placementapi.com/v1/standing_orders/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

status'active' | 'paused'
briefobject
cadence'weekly' | 'biweekly' | 'monthly'
links_per_runinteger
budget_credits_per_runinteger
mode'approve' | 'auto'
if_no_content'convert_to_service' | 'cancel' | 'null' nullable
content_mode'publisher' | 'service' | 'supplied' | 'papi_written' | 'null' nullable
next_run_atstring date-time

Response

OK

standing_order_idstring
target_urlstring
briefobject

The plan_links brief to re-run; links and budget are overridden by links_per_run and budget_credits_per_run.

cadence'weekly' | 'biweekly' | 'monthly'
links_per_runinteger
budget_credits_per_runinteger
mode'approve' | 'auto'
if_no_content'convert_to_service' | 'cancel' | 'null' nullable
content_mode'publisher' | 'service' | 'supplied' | 'papi_written' | 'null' nullable
status'active' | 'paused'
next_run_atstring nullable
last_run_atstring nullable
last_quote_idstring nullable
last_outcomestring nullable
last_outcome_detailstring nullable
created_atstring

Changes

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