contacts

Submit a contact-record form

Changed on

Completes a contact_record_request the assistant broadcast: writes the record the guardian confirmed, then unblocks the waiting command. A create or update writes display name and notes, never a channel; a merge moves the donor's channels to the survivor and deletes the donor. A cancelled submission unblocks the command without writing.

post/v1/contacts/record/submit

Request

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

Request body

requestIdstring required

The contact_record_request id broadcast by the assistant

operation'create' | 'update' | 'delete' | 'merge'

Required unless cancelled is true

contactIdstring

Required to update or delete, and the survivor of a merge

donorContactIdstring

The contact merged away. Required for a merge.

displayNamestring
notesstring nullable
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