VEverdun
parents

Purchase Disarm Number

post/parents/{parent_id}/disarm-number

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}/disarm-number
  • Auth
    HTTP bearer

Path parameters

parent_idstring required

Request body

area_codestring nullable

Preferred NANP area code for the new number. Omit to let Surge choose. Ignored when an in-flight purchase is being reconciled.

Example request

{
  "area_code": "801"
}

Response

Successful Response

disarm_numberstring nullable

The dealer's Surge line in E.164, which their customers text with a site passcode. Null while a purchase is unconfirmed.

disarm_number_statestring nullable

'purchasing' means a purchase was started and its outcome is not yet confirmed — re-POST to reconcile against Surge rather than buying a second number. 'attached' is display only: inbound texts route regardless of campaign attachment. 'releasing' means a release is in flight or unconfirmed: this client's sites cannot be disarmed until it clears, and re-DELETE reconciles it.

surge_phone_number_idstring nullable

Surge's own id for the number, used by the attach webhook and release.

adoptedboolean

True when this call RECONCILED an earlier ambiguous purchase by adopting a number Surge already had, rather than buying a new one.

Example response

{
  "disarm_number": "+18015550199",
  "disarm_number_state": "purchasing",
  "surge_phone_number_id": "pn_01H…",
  "adopted": true
}

Changes

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