orders (admin)

Record a comped order — work promised without a payment

The comp path, and the same argument as granting a boost by hand: comping is real, and the alternative is writing a fake Payment row to make the queue look right, which would corrupt the one table that reconciles against Stripe. So this creates no Payment row and the order's paymentId stays null.

Every field but kind is optional. An operator arranging a guest post over email may have only an address at this point, and refusing the row until the brief is complete is how the order ends up not recorded at all.

Fires order.received, with the same keys a paid order sends and nulls where the payment would have been.

post/v1/directories/{directoryId}/orders

Request

  • Base URL: https://api.epicdirectories.com
  • URL: https://api.epicdirectories.com/v1/directories/{directoryId}/orders
  • Auth: HTTP bearer

Path parameters

directoryIdstring required

Request body

kind'guest_post' | 'niche_edit' required
purchaserEmailstring

Who the work is discussed with. Not validated as an email: this is a note to the operator, and nothing sends mail to it — there is no email infrastructure in this system.

targetUrlstring

Link destination the post should point at.

anchorTextstring
briefstring

Topic, a link to a draft, or instructions.

operatorNotesstring

Why it was comped, ideally.

Response

The created order

Changes

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