Logo
Bellhop API Documentation

Create a lead

POST {{HOST}}/api/partner-api/v0/sales/leads

Create a sales lead.

Available Fields

  • See examples for a list of available fields (multiple examples)

Required Scopes

  • sales:leads:create

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "first_name": "Barnabus", "last_name": "Bellhop", "description": "", "external_id": "d11d1a9a-e584-48d6-a571-29a29e2c5baa", "email": "Barnabus.Bellhop@bellhop.com", "phone": "000-000-0000", "origin_street": "", "origin_city": "", "origin_postal_code": "00000", "origin_state": "", "destination_street": "", "destination_city": "", "destination_postal_code": "00000", "destination_state": "", "lead_type": "Long Distance", "lead_record_type": "0TEST", "load_date": "2020-11-18", "close_date": null }



Curl
curl -X POST 'HOST/api/partner-api/v0/sales/leads' -d '{"first_name":"First","last_name":"Name","email":"first.name@bellhop.com","phone":"000-000-0000","origin_postal_code":"00000","destination_postal_code":"00000","lead_type":"Long Distance","lead_record_type":"Long Distance Move","load_date":"2020-11-18"}'

ENDPOINTS