LeadSquared Developer Centre

ON THIS PAGE

Create an Account


Lets you create a new account (company) in your LeadSquared application.

  • Specify an existing “Company Type Name” in the JSON body.
  • The “Company Name” attribute is mandatory but you can pass other attribute-value pairs (for Phone Number, Website, etc.)

To learn more about the LeadSquared Accounts feature, see LeadSquared Accounts Settings.

 

API URL

URL
Icon
POST https://{host}/v2/CompanyManagement.svc/Company.Create?accessKey=AccessKey&secretKey=SecretKey

Request

Content-Type: application/json
JSON Body/Payload Icon
{
    "CompanyType": {
    "CompanyTypeName": "Partners"
    },
    "CompanyProperties": [
        {"Attribute": "CompanyName","Value": "Partner Name"},
        {"Attribute": "Phone","Value": "+91-8923748971"},
        {"Attribute": "Website","Value": "www.partner.com"}
    ]
}

Request Parameters

Parameter Description
CompanyType

Pass the name of an exiting company type here.

Note: You cannot create a new company type using the API.

CompanyName

This parameter is mandatory. Pass the name of the new company you want to create.

Phone

You can pass other company attributes like company phone number.

Website

You can pass other company attributes like company website..

Response

200 OK
Content-Type: application/json
{
   "Status": "Success",
   "Message": {"Id": "66e996af-db9b-433b-9a4e-589195e69e5c"}
}

HTTP Response Codes

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.

On this page

© 2022 by MarketXpander Services Pvt Ltd. All Rights Reserved.