Create Customer

Overview

Use this API to create an individual, corporate and group customer.

  • An individual customer can have only one contact.
  • A corporate and group customer can have one or more contacts.
  • A contact can have one or more contact points.
  • Only one customer can be created at a time.

    Permissions

    Actor Permission
    User All of the following are required:
    • User must have 'Create Customer' action.
    • If "Customer departmentalization" setting is enabled in the application, then created customer must belong to either the user's home department, or to the department where the user is a foreign user.
    Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
customerType
required
string

Customer Types

Enum: "individual" "corp" "group"
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Content-Type
required
string
Default: application/json

Media type sent by the client.

Enum: "application/json" "application/xml" "application/x-www-form-urlencoded" "multipart/form-data" "text/plain"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema: application/json

The request body is mandatory. Request body can be in either XML or JSON format. The request body is mandatory. Request body can be in either XML or JSON format.

Elements required in request body

Name Description Customer Type
department.name Name of the department in which the customer should be created. Department name is required only If "Customer departmentalization" setting is enabled in the application.
  • Individual
  • Group
  • Corporate
type.value Customer type.
  • Individual
  • Group
  • Corporate
contacts.contact Only one contact can be created for an individual customer. For required and optional elements of contact, refer create contact.
  • Individual
customerName Name of the customer.
  • Group
  • Corporate
type.group.type.value Type of group of the customer. Must be one of the values configured in application.
  • Group

Optional elements allowed in request body

Name Description Customer Type
level.value Level of the customer. Must be one of the values configured in application.
  • Individual
  • Group
  • Corporate
role.value Role of the customer.
  • Individual
  • Group
  • Corporate
pin Customer pin information.
  • Individual
  • Group
  • Corporate
howReferred.value Specifies how the customer was referred
  • Individual
  • Group
  • Corporate
industry.value Industry that this customer belongs to. Must match the value configured in application.
  • Individual
  • Group
  • Corporate
marketSegment Market segment of the customer
  • Individual
  • Group
  • Corporate
entitlements Entitlements of the customer.
  • Individual
  • Group
  • Corporate
customAttributes Name must match one of the custom attributes configured in application. If the custom attribute is configured as an enumeration, the value must be one of the predefined values.For string type of custom attribute that is not configured as an enumeration, refer list of Allowed Characters For Custom Attributes.
  • Individual
  • Group
  • Corporate
contacts.contact One or more contact persons can be provided. For required and optional elements of contact, refer create contact.
  • Group
  • Corporate
type.group.region Region of operation of the group customer
  • Group
type.group.numberOfMembers Number of members in the group
  • Group
type.group.income Income of the group customer
  • Group
type.group.currency Currency used while dealing with the group customer
  • Group
type.group.registrationNumber Registration number of the group customer
  • Group
type.group.affiliation Affiliation of the group customer
  • Group
type.corporate.region Region of operation of corporate customer. Must be one of the values configured in application.
  • Corporate
type.corporate.numberOfEmployees Number of employees in the organization
  • Corporate
type.corporate.revenues Revenue of the corporate customer
  • Corporate
type.corporate.currency Currency used while dealing with the corporate customer
  • Corporate
type.corporate.registrationNumber Registration number of the corporate customer
  • Corporate
type.corporate.sector Sector of the corporate customer
  • Corporate
Array of objects (link) >= 0 items

self link

object (cases)

Link to fetch cases of the requested customer.

customerName
string (customerName)

Name of the customer

object (department)

ID and name of the department

object (type)

Type and type-specific details of the customer

object (group)

Details specific to group customer

object (corporate)

Details specific to corporate customer

object (level)

Level of the customer

object (preferredAgent)

ID and name of the preffered agent for the requested customer

object (role)

Internal value and display value of the role of the customer

pin
string (pin)

Customer pin information

object (howReferred)

Specifies how the customer was referred

created
string <date-time> (created)

Customer creation Date and Time details.

object (createdBy)

Details of user who created customer.

lastModified
string <date-time> (lastModified)

Customer last modified Date and Time details.

object (lastModifiedBy)

Details of user who modified customer.

object (industry)

Industry that this customer belongs to.

marketSegment
string (marketSegment)

Market segment of the customer.

entitlements
string (entitlements)

Entitlements of the customer.

object (CustomAttributes)

Name and value of all the custom attributes configured for the Customer Object

object (contacts)

Details of all contacts associated with the requested customer

Array of objects (notes) >= 0 items

Link to retrieve all notes of the customer

id
string (id)

Customer ID

Responses
201

When created successfully

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/{customerType}/customer
Request samples
application/json
{
  • "type": {
    },
  • "contacts": {
    }
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}