contacts

Submit a contact-prompt address

Changed on

Completes a contact_request the assistant broadcast: writes the contact and channel gateway-first, then unblocks the waiting prompt.

post/v1/contacts/prompt/submit

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/contacts/prompt/submit
  • Auth
    none declared

Request body

requestIdstring required

The contact_request id broadcast by the assistant

addressstring

Required unless cancelled is true

channelTypestring

Required unless cancelled is true

rolestring
displayNamestring
contactIdstring

The contact the parked form targets, echoed back from the broadcast. The parked form is authoritative.

verifyboolean

The form's 'mark verified' checkbox as the guardian left it. Omit only from clients that predate the checkbox; the parked command's flag is then used instead.

cancelledboolean

The guardian dismissed the form. Unblocks the waiting command without writing.

Response

Successful response

acceptedboolean required
errorstring
duplicateboolean

Another client answered this form first. Nothing is wrong, but none of this submission's values were written.

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the optional property to the response with the status