API Reference

Add a new customer.

post
https://api.visualvisitor.com/api/v1/partner/customers/

Must be a partner.
Minimal scope required: "customer.all".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifies the product the customer will use.
Supported products include [person, employee].

Query Params
string | null
Body Params

The JSON object containing the data needed to create the customer.

DTO used to add the customer's details.

string
required
length between 1 and 300

The name of the customer's company.

string
required
length between 1 and 300

The domain name for the customer's company.

string
required
length between 1 and 300

The primay user's first name.

string
required
length between 1 and 300

The primay user's last name.

string
required
length ≥ 1

The primay user's email address.

string
required
length ≥ 1

The primay user's phone number.

string
required
length between 6 and 100

The primay user's password.

string
required
length ≥ 1

The primay user's timezone.

boolean

Notifies the system to send a welcome email to the primary user.

boolean

Indicates whether the customer has opted to use the built-in cookie consent form on their site.

cookieConsentOwnershipDetails

Contains the customer's information required to configure the cookie consent form to be used on their site.

Headers
string | null
Responses

500

Updated over 1 year ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?