get_status for a quote, with a message to the operator

This is get_status with the optional message, as a POST so that the text is in the body, not in the URL (which servers log). Without a message (empty body, or {"message": null}) it is a plain status call, like the GET. With a message it is written to the thread and e-mailed to the operator, and the answer is the same as the GET's, including your message (from: agent) and message_sent: true. Read the operator's message first, then reply: while the operator has written something you have not read yet, nothing is stored or e-mailed; the answer is the GET's, with that message in messages, message_sent: false and a next_action that says so, and you send your answer with the next call (HTTP 200 either way, so check message_sent). Plain text, 1-2000 characters, never interpreted as HTML; an empty or longer message is a 400. Limits: 10 messages per hour per quote (its quote_id and task_id share it) and 30 per hour per client address (429). The same text again within 10 minutes, while it is still the newest message of the thread, is not stored or e-mailed a second time (the answer then has duplicate_ignored: true). It needs the same access_token as the GET; without one, or with another quote's, nothing is stored or sent (401).

post/quotes/{quote_id}

Request

  • Base URL: https://api.handsforagents.com/v1
  • URL: https://api.handsforagents.com/v1/quotes/{quote_id}
  • Auth: HTTP bearer

Path parameters

quote_idstring required

Request body

messagestring nullable

Your reply to the operator: plain text, 1-2000 characters, never HTML. Null or absent: a plain status call.

Response

The same answer as the GET, now including your message; if the operator had written something you had not read, message_sent is false, nothing was stored and the answer shows that message

quote_idstring required
status'received' | 'quoted' | 'refused' | 'expired' required
refusal_reasonstring

Present when status is refused. Refused requests are not invoiced.

refusal_code'credentials' | 'impersonation' | 'surveillance' | 'social-manipulation' | 'verification-bypass' | 'referral-fraud' | 'weapons-regulated' | 'counterfeit' | 'reshipping-fraud' | 'illegal' | 'capability-limit' | 'sensitive-unverified' | 'other'

Present when status is refused: the category from the task policy, or capability-limit / sensitive-unverified / other.

task_idstring

Present once create_task was called for this quote.

scopestring
deliverablesstring
evidencestring[]

What the evidence package will contain.

subcontractedstring

Processes done by subcontractors, if any.

delivery_datestring date
inbound_addressstring

Where to send parts or parcels, if the task needs them.

operator_verification_requiredboolean

True for the sensitive task categories.

valid_untilstring date
terms_versionstring
next_actionstring

One or two sentences in English: what the agent or the client should do now.

duplicate_ignoredboolean

Present and true only in the answer to a POST whose message was ignored because the same text was already the newest message of the thread (sent within the last 10 minutes).

message_sentboolean

Present only in the answer to a POST with a message: true, the message was stored and e-mailed to the operator; false, it was NOT stored because the operator had written something you had not read yet (that message is in messages, now marked as read; next_action says so): send your answer again. Absent when the same text was ignored (duplicate_ignored) and in every plain status call.

test_modeboolean

Present and true only for a test quote: an order made from it is a test order.

Changes

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