api
customers

Changed on

Create Customer

post/api/customers

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/customers
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Request body

companystring nullable

The company of the customer

namestring nullable

The name of the customer collected from first name and last name

prenamestring nullable

The first name of the customer

lastnamestring nullable

The lastname of the customer

numbernumber float

The number of the customer. Need to be unique and incrementing

imagestring nullable

The image of the customer

primaryEmailstring email required

The primary email of the customer

notesstring nullable

Notes of the customer

extraFieldsobject nullable

Extra fields of the customer

tagsstring[]

An array of tags

verifiedboolean

Whether the customer is verified

metaobject

Custom key-value data. Metadata is useful for storing additional, structured information on an object.

externalIdstring nullable

An external identifier of the customer

phonestring nullable

The phone number of the customer

upsertboolean

If false, reject creation when the email already exists

Response

OK

_idstring required

The ID of the customer

companystring nullable

The company of the customer

namestring nullable

The name of the customer collected from first name and last name

prenamestring nullable

The first name of the customer

lastnamestring nullable

The lastname of the customer

imagestring nullable

The image of the customer

primaryEmailstring email required

The primary email of the customer

numbernumber float

The number of the customer. Need to be unique and incrementing

phonestring

The phone number of the customer

sellerIdstring

The ID of the seller of the customer

notesstring nullable

Notes of the customer

extraFieldsobject nullable

Extra fields of the customer

tagsstring[]

An array of tags

segmentsstring[]

An array of segment slugs, read only

blockedboolean

Whether the customer is blocked

verifiedboolean

Whether the customer is verified

metaobject

Custom key-value data. Metadata is useful for storing additional, structured information on an object.

externalIdstring nullable

An external identifier of the customer

createdAtstring date-time

An ISO timestamp indicating when the customer was created

updatedAtstring date-time

An ISO timestamp indicating when the customer was updated

Changes

  • 36be0dca14e7Revision changes
    • breaking

      removed subschema #1 subschema #2 from the / request property oneOf list

    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • info

      added subschema #1 subschema #2 to the / request property oneOf list

    • info

      removed subschema #1 subschema #2 from the / response property oneOf list for the response status