API - Creating a Lead

How to create a Lead with data from a request.

Route

POST /leads?apitoken=your-token&i=your-instance

Full endpoint: https://sprinthub-api-master.sprinthub.app/leads?apitoken=your-token&i=your-instance

Query Params

Key	Description
i	Identifier of your instance, subdomain
apitoken	API token

Body - System default fields

Key	Expected value
firstname	String
lastname	String
email	String Only one email: "email@mail" Multiple emails: "[email protected], [email protected]"
whatsapp, mobile (cell phone), phone (landline)	String Format: "[phone]"
country	String Written in English, for example: "Brazil"
state	String
city	String
address	String
zipcode (cep)	String Format: "69092250"
timezone	String Format: "America/Sao_Paulo"
preferred_locale (language)	String Format: "pt-BR"

Example of Lead creation

The data to be added to the Lead were inserted in the request body. The request was sent using the software Postman. The expected response is the Lead data after the moment of creation, including unfilled fields.

POST request to create a Lead.