Create Lead
The API is used to create a lead under the realm of GO's platform. The API will provide an identification of the lead within the realm. The access token generated in the login request is used here.
{{server}} = https://rm-portal-prepoduction.signzy.app/
Key | Data Type | Required/Optional | Description |
Header | | | |
Authorization | String | Required | A JSON Web Token (JWT) that authenticates and authorizes the request. |
Content-Type | String | Required | application/json |
Body | | | |
name | String | Required | The name of the lead. |
String | Required | The email address of the lead. | |
phone | String | Required | The phone number of the lead. |
productCode | String | Required | The code for the product the lead is interested in. |
source | String | Required | The source of the lead, such as "website" or "referral". |
myField | String | Required | A custom field for any additional information about the lead. |
- If successful, the API will return a response with a status code of 200 OK and the newly created lead in the response body.
- If unsuccessful, the API will return a response with a status code indicating the error type.
Key | Data type | Description |
id | String | Lead Id |
name | String | Name |
String | ||
phone | String | Phone |
applicationId | String | Application ID (Realm identifier) |
status | String | Status of the lead (open, converted (qualified, unqualified, closed) |
junk | String | If there are junk values within the lead created (for example, invalid email id, phone) |
createdBy | String | Name of the manager, RM who has created the issue |
productCode | String | Product in which the lead is interested |
source | String | Lead source |
myField | String | Additional fields which are to be added within the lead |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].