People

This page has all the methods related to People (Customers).

Note that "People" and "Customers" are the same thing. Internally, we just call them Customers because that's what they were called when Productlane was first launched :)

POSTcreateCustomer

Create a person

Creates a new Person (Customer)

Params

  • Name
    name
    Type
    string
    Description

    Name of the person (1-255 chars)

  • Name
    email
    Type
    string
    Description

    Email of the person

  • Name
    segments
    Type
    string[]
    (optional)
    Description

    Array of Segment IDs that will automatically be assigned to the person.

Result

  • Name
    result
    Type
    Customer
    Description

    The newly created person

  • Name
    error
    Type
    Error
    Description

    Null if the request succeeded, otherwise an error object

Request

POST
/createCustomer
{
	"params": {
		"email": "john@example.com",
		"name": "John Doe",
		"segments": ["aab6ca4f-9b30-4341-80f3-528595d61b94"]
	}
}

Response

{
	"result": {
		"id": "5bc8c471-55a2-43d9-9ad5-a8ab9eb49169",
		"createdAt": "2023-02-18T14:30:20.272Z",
		"updatedAt": "2023-02-18T14:30:20.272Z",
		"email": "john@example.com",
		"name": "John Doe",
		"organizationId": "922eb553-8dc5-4a00-a16b-01735334be53",
		"companyId": null
	}
	"error": null
}