aid_customers_post

Create a new customer, customer_id, email and phone_number must be unique if specified. scopes:

admin:customers
write:customers
create:customers:/users

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Request body

metadataobject

A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format. You can unset an individual key by setting its value to null and then saving. To clear all keys, set metadata to null

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

updated_atstring date-time

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time

first_namestring nullable

last_namestring nullable

emailstring nullable

customer email, case insensitive duplication control prevents multiple user with same type to have equal email

customer@example.com is equal to CUStOMer@EXAMPLE.com

phone_numberstring ^\+?[1-9]\d{1,14}$ nullable

A phone number in E.164 number formatting.

attributesobject

Custom attributes

statusstring nullable

Status of the customer

favorite_storestring nullable

customer favorite store

type'customer' | 'company' | 'contact' | 'employee' | 'other' required

Describe type of a user.

company property is required when using the type company
company property is only supported for users with type other or company
Creating or updating user with type employee or other requires admin:customers or write:customers scope.
User login is only available for users with type customer or company

genderstring nullable

date_of_birthstring date nullable

customer_idstring

The customer id you have defined for the customer. (must not have trailing or leading spaces) An auto-generated customer_id will be created if no customer_id is provided.

passwordstring

The customer password. The caller must have scope write:accounts:/auth/users when password is included in the body

pinstring

6 digit customer pin, can only used for MFA login. The caller must have scope write:accounts:/auth/users when pin is included in the body

Example request

{
  "metadata": {
    "dob_year": 1985
  },
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "first_name": "John",
  "last_name": "Doe",
  "email": "customer@example.com",
  "phone_number": "+4799999999",
  "enrolled_by": {
    "type": "url",
    "value": "https://facebook.com"
  },
  "marketing_consent": {
    "sms": {
      "consent": true,
      "updated_at": "2018-01-12T13:42:00Z"
    },
    "email": {
      "consent": true,
      "updated_at": "2018-01-12T13:42:00Z"
    }
  },
  "addresses": [
    {
      "address_line": "Sommerkroveien 34",
      "address_line_2": "PB 123",
      "postal_code": "0349",
      "postal_place": "Oslo",
      "country": "NO",
      "latitude": 59.942112,
      "longitude": 10.716991,
      "comment": "5th floor, use doorbell."
    }
  ],
  "company": {
    "organization_number": "123456789MVA",
    "bussiness_name": "TKP tech AS",
    "department": "sales department",
    "industry": "computer industry"
  },
  "gender": "male",
  "date_of_birth": "1990-09-20"
}

Response

Customer created

metadataobject

A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format. You can unset an individual key by setting its value to null and then saving. To clear all keys, set metadata to null

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

updated_atstring date-time

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time

first_namestring nullable

last_namestring nullable

emailstring nullable

customer email, case insensitive duplication control prevents multiple user with same type to have equal email

customer@example.com is equal to CUStOMer@EXAMPLE.com

phone_numberstring ^\+?[1-9]\d{1,14}$ nullable

A phone number in E.164 number formatting.

attributesobject

Custom attributes

statusstring nullable

Status of the customer

favorite_storestring nullable

customer favorite store

type'customer' | 'company' | 'contact' | 'employee' | 'other' required

Describe type of a user.

company property is required when using the type company
company property is only supported for users with type other or company
Creating or updating user with type employee or other requires admin:customers or write:customers scope.
User login is only available for users with type customer or company

genderstring nullable

date_of_birthstring date nullable

customer_idstring required

The customer id you have defined for the customer. (must not have trailing or leading spaces) An auto-generated customer_id will be created if no customer_id is provided.

Example response

{
  "metadata": {
    "dob_year": 1985
  },
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "first_name": "John",
  "last_name": "Doe",
  "email": "customer@example.com",
  "phone_number": "+4799999999",
  "enrolled_by": {
    "type": "url",
    "value": "https://facebook.com"
  },
  "marketing_consent": {
    "sms": {
      "consent": true,
      "updated_at": "2018-01-12T13:42:00Z"
    },
    "email": {
      "consent": true,
      "updated_at": "2018-01-12T13:42:00Z"
    }
  },
  "addresses": [
    {
      "address_line": "Sommerkroveien 34",
      "address_line_2": "PB 123",
      "postal_code": "0349",
      "postal_place": "Oslo",
      "country": "NO",
      "latitude": 59.942112,
      "longitude": 10.716991,
      "comment": "5th floor, use doorbell."
    }
  ],
  "company": {
    "organization_number": "123456789MVA",
    "bussiness_name": "TKP tech AS",
    "department": "sales department",
    "industry": "computer industry"
  },
  "gender": "male",
  "date_of_birth": "1990-09-20"
}

v1

aid_customers_post

Path parameters

Request body

Example request

Response

Example response