Submit or replace the brief on a paid order

Requires orders:write. POST is accepted as an alias. The body is the brief itself, or wrapped as { "brief": { ... } }. Same quality gate as the website brief form. Locked once a draft is out for approval or a placement is live (409 brief_locked).

put/api/agent/v1/orders/{id}/brief

Request

  • Base URL: https://essentras.com
  • URL: https://essentras.com/api/agent/v1/orders/{id}/brief
  • Auth: HTTP bearer

Path parameters

idstring required

The order id returned by POST /orders or GET /orders.

Request body

subject_namestring required

Who or what the article is about.

subject_titlestring
linksstring required

Must contain at least one real link.

goalstring required

The business and what the coverage should achieve.

avoidstring
title_ideasstring
notesstring

Response

The updated order

object'order'
idstring

Order id for the API (the public id).

numberinteger nullable
statusstring
payment_statusstring
fulfillment'awaiting_payment' | 'awaiting_brief' | 'in_progress' | 'partially_published' | 'published' | 'cancelled' | 'refunded'
channel'api' | 'reseller_portal' | 'website'
created_atstring date-time
paid_atstring date-time nullable
currency'USD'
pricing_basis'list' | 'reseller'
subtotalnumber
discountnumber
discount_reasonstring nullable
totalnumber
paid_from_walletnumber
client_referencestring nullable
dashboard_urlstring uri

Changes

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