Identify Customer

Creates a new customer or updates an existing customer record.

Create Customer

POST https://beacon.crowdpower.io/customers

Request Body

NameTypeDescription

user_id*

string

A unique ID for the user.

name

string

The user’s name. If provided, will be split up into first and last name.

first_name

string

The user’s first name. Prioritized over name field, if both are included in request.

last_name

string

The user’s last name. Prioritized over name field, if both are included in request.

email

string

The user’s email address. Required if user_id is not present.

phone

string

The user’s phone number. For best results use E.164 formatting.

signed_up_at

integer

When the user signed up to your service. UNIX timestamp in seconds.

ip

string

The user’s IP address.

custom_attributes

object

Information about the user, sent as key/value pairs. Use snake_case for key names.

update_session

boolean

Whether or not to update the user’s session. Defaults to true.

{
  "success": true,
  "code": 200,
  "data": null
}

Create Multiple Customers

POST https://beacon.crowdpower.io/customers/bulk

Path Parameters

NameTypeDescription

customers*

array

An array of customer objects.

{
  "success": true,
  "code": 200,
  "data": null
}

Last updated