VEverdun
parents

Edit Parent

put/parents/{parent_id}

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/parents/{parent_id}
  • Auth
    HTTP bearer

Path parameters

parent_idstring required

Request body

company_namestring required

Name of the client

type'Monitoring Dealer' | 'End User' | 'Internal' required
primary_contact_namestring required

Name of the primary contact

primary_contact_phone_numberstring required

Phone number of the primary contact

primary_contact_emailstring required

Email of the primary contact

notesstring nullable

Notes about the client

Example request

{
  "company_name": "Joe",
  "primary_contact_name": "Joe Johnson",
  "primary_contact_phone_number": "1013217890",
  "primary_contact_email": "JJ@example.com",
  "notes": "Super important notes"
}

Response

Successful Response

idstring uuid required

Unique client id

company_namestring required

Name of the client

type'Monitoring Dealer' | 'End User' | 'Internal' required
primary_contact_namestring required

Name of the primary contact

primary_contact_phone_numberstring required

Phone number of the primary contact

primary_contact_emailstring required

Email of the primary contact

notesstring nullable

Notes about the client

disarm_numberstring nullable

The dealer's SMS line, which their customers text with a site passcode to turn cameras off. Null until one is bought.

disarm_number_statestring nullable

'purchasing' means a purchase started and its outcome is unconfirmed -- re-POST to reconcile. 'attached' is display only: inbound texts route regardless of campaign attachment. 'releasing' means the line is being given back to Surge: new disarms are refused for this client until it clears, and a re-DELETE reconciles it.

Example response

{
  "id": "<UUID of some sort>",
  "company_name": "Joe",
  "primary_contact_name": "Joe Johnson",
  "primary_contact_phone_number": "1013217890",
  "primary_contact_email": "JJ@example.com",
  "notes": "Super important notes",
  "disarm_number": "+18015550199",
  "disarm_number_state": "purchasing"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.