This example demonstrates the following:
Request
| Method | URL |
|---|---|
| POST | /ws/v12/interaction/customer |
Request headers
| Name | Value |
|---|---|
| X-egain-session | Valid session ID |
| Accept | application/xml |
| Content-Type | application/xml |
| Accept-Language | en-US |
Request body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <customer xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/customer" xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/platform" xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/common"> <type> <value>group</value> <group> <type> <ns3:value>Association</ns3:value> </type> </group> </type> <customerName>Unichem Laboratories Limited</customerName> </customer>
Response
HTTP/1.1 201 Created
Response headers
| Name | Value |
|---|---|
| X-egain-session | current session ID |
| Content-Type | application/xml |
| Location | /system/ws/v12/interaction/customer/2805 |
Request
| Method | URL |
|---|---|
| POST | /ws/v12/interaction/customer |
Request headers
| Name | Value |
|---|---|
| X-egain-session | Valid session ID |
| Accept | application/json |
| Content-Type | application/json |
| Accept-Language | en-US |
Request body
{
"type": {
"value": "group",
"group": {
"type": {
"value": "Association"
}
}
},
"customerName": "Unichem Laboratories Limited"
} Response
HTTP/1.1 201 Created
Response headers
| Name | Value |
|---|---|
| X-egain-session | current session ID |
| Content-Type | application/json |
| Location | /system/ws/v12/interaction/customer/2806 |
This example demonstrates the following:
Request
| Method | URL |
|---|---|
| POST | /ws/v12/interaction/customer |
Request headers
| Name | Value |
|---|---|
| X-egain-session | Valid session ID |
| Accept | application/xml |
| Content-Type | application/xml |
| Accept-Language | en-US |
Request body
<?xml version="1.0" encoding="UTF-8"?>
<customer xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/customer" xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/platform" xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/common" xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson" xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint">
<department>
<ns2:name>Service</ns2:name>
</department>
<type>
<value>group</value>
<group>
<type>
<ns3:value>Membership</ns3:value>
</type>
<region>Europe</region>
<numberOfMembers>12</numberOfMembers>
<income>1000000</income>
<currency>USD</currency>
<registrationNumber>324</registrationNumber>
<affiliation>FCMA</affiliation>
</group>
</type>
<customerName>Unichem Laboratories Limited</customerName>
<level>
<ns3:value>Platinum</ns3:value>
</level>
<role>
<ns3:value>Partner</ns3:value>
</role>
<pin>0121</pin>
<howReferred>
<ns3:value>Reseller</ns3:value>
</howReferred>
<industry>
<ns3:value>Health care</ns3:value>
</industry>
<marketSegment>Medical Products</marketSegment>
<entitlements>Free service</entitlements>
<customAttributes>
<ns3:customAttribute>
<ns3:attribName>preferredlang</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>English</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</customAttributes>
<contactPersons>
<ns4:contactPerson>
<ns4:salutation>Mr.</ns4:salutation>
<ns4:firstName>Kriag</ns4:firstName>
<ns4:middleName>Goldman</ns4:middleName>
<ns4:lastName>Francis</ns4:lastName>
<ns4:loginId>kriag</ns4:loginId>
<ns4:gender>
<ns3:value>male</ns3:value>
</ns4:gender>
<ns4:identification>
<ns4:type>SSN</ns4:type>
<ns4:value>111-22-8765</ns4:value>
</ns4:identification>
<ns4:suffix>
<ns3:value>i</ns3:value>
</ns4:suffix>
<ns4:initials>A.</ns4:initials>
<ns4:secretQuestion>Place of Birth</ns4:secretQuestion>
<ns4:secretAnswer>Sunnyvale</ns4:secretAnswer>
<ns4:hasDirectMailingConsent>true</ns4:hasDirectMailingConsent>
<ns4:hasDirectCallingConsent>true</ns4:hasDirectCallingConsent>
<ns4:hasHoldingDataConsent>true</ns4:hasHoldingDataConsent>
<ns4:jobTitle>Assistant</ns4:jobTitle>
<ns4:employmentStatus>
<ns3:value>full-time</ns3:value>
</ns4:employmentStatus>
<ns4:priority>High</ns4:priority>
<ns4:dateOfBirth>1965-12-09T00:00:00.000Z</ns4:dateOfBirth>
<ns4:maritalStatus>
<ns3:value>divorced</ns3:value>
</ns4:maritalStatus>
<ns4:type>
<ns3:value>Legal</ns3:value>
</ns4:type>
<ns4:firstNameFurigana>Kriag</ns4:firstNameFurigana>
<ns4:middleNameFurigana>Goldman</ns4:middleNameFurigana>
<ns4:lastNameFurigana>Francis</ns4:lastNameFurigana>
<ns4:startGreeting>Hey, Welcome</ns4:startGreeting>
<ns4:endGreeting>Have a Nice Day!</ns4:endGreeting>
<ns4:spouseName>Kethel</ns4:spouseName>
<ns4:emergencyContact>998-765-4321</ns4:emergencyContact>
<ns4:occupation>Branch Manager</ns4:occupation>
<ns4:incomeLevel>40000-50000</ns4:incomeLevel>
<ns4:educationLevel>
<ns3:value>graduate</ns3:value>
</ns4:educationLevel>
<ns4:race>African</ns4:race>
<ns4:dependents>4</ns4:dependents>
<ns4:isSmoker>true</ns4:isSmoker>
<ns4:hobbies>Farming</ns4:hobbies>
<ns4:interests>Painting</ns4:interests>
<ns4:contactOrder>1985</ns4:contactOrder>
<ns4:customAttributes>
<ns3:customAttribute>
<ns3:attribName>isprimary</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>y</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</ns4:customAttributes>
<ns4:contactPoints>
<ns5:contactPoint>
<ns5:type>
<ns5:value>phone</ns5:value>
<ns5:phone>
<ns5:type>
<ns3:value>mobile</ns3:value>
</ns5:type>
<ns5:phoneNo>234 3456</ns5:phoneNo>
<ns5:countryCode>1</ns5:countryCode>
<ns5:areaCode>408</ns5:areaCode>
<ns5:extension>102</ns5:extension>
<ns5:availability>
<ns5:days>
<ns3:value>weekends</ns3:value>
</ns5:days>
<ns5:times>
<ns3:value>anytime</ns3:value>
</ns5:times>
</ns5:availability>
</ns5:phone>
</ns5:type>
<ns5:priority>
<ns3:value>high</ns3:value>
</ns5:priority>
<ns5:customAttributes>
<ns3:customAttribute>
<ns3:attribName>prioritysequence</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>1</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</ns5:customAttributes>
</ns5:contactPoint>
<ns5:contactPoint>
<ns5:type>
<ns5:value>postal</ns5:value>
<ns5:postal>
<ns5:type>
<ns3:value>billto</ns3:value>
</ns5:type>
<ns5:address_1>345</ns5:address_1>
<ns5:address_2>E Midfield Rd</ns5:address_2>
<ns5:city>Mountain View</ns5:city>
<ns5:state>Ca</ns5:state>
<ns5:zip>98704</ns5:zip>
<ns5:country>USA</ns5:country>
<ns5:region>United States</ns5:region>
</ns5:postal>
</ns5:type>
<ns5:priority>
<ns3:value>low</ns3:value>
</ns5:priority>
<ns5:customAttributes>
<ns3:customAttribute>
<ns3:attribName>prioritysequence</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>2</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</ns5:customAttributes>
</ns5:contactPoint>
<ns5:contactPoint>
<ns5:type>
<ns5:value>email</ns5:value>
<ns5:email>
<ns5:emailAddress>kriag.goldman@customer.com</ns5:emailAddress>
</ns5:email>
</ns5:type>
<ns5:priority>
<ns3:value>high</ns3:value>
</ns5:priority>
<ns5:customAttributes>
<ns3:customAttribute>
<ns3:attribName>prioritysequence</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>3</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</ns5:customAttributes>
</ns5:contactPoint>
</ns4:contactPoints>
</ns4:contactPerson>
<ns4:contactPerson>
<ns4:salutation>Mrs.</ns4:salutation>
<ns4:firstName>Jeniffer</ns4:firstName>
<ns4:middleName>Goldman</ns4:middleName>
<ns4:lastName>Francis</ns4:lastName>
<ns4:loginId>Jfrancis</ns4:loginId>
<ns4:gender>
<ns3:value>female</ns3:value>
</ns4:gender>
<ns4:identification>
<ns4:type>SSN</ns4:type>
<ns4:value>111-22-8766</ns4:value>
</ns4:identification>
<ns4:suffix>
<ns3:value>sr.</ns3:value>
</ns4:suffix>
<ns4:initials>J.</ns4:initials>
<ns4:secretQuestion>Place of Birth</ns4:secretQuestion>
<ns4:secretAnswer>Texas</ns4:secretAnswer>
<ns4:hasDirectMailingConsent>false</ns4:hasDirectMailingConsent>
<ns4:hasDirectCallingConsent>false</ns4:hasDirectCallingConsent>
<ns4:hasHoldingDataConsent>true</ns4:hasHoldingDataConsent>
<ns4:jobTitle>Manager</ns4:jobTitle>
<ns4:employmentStatus>
<ns3:value>contract</ns3:value>
</ns4:employmentStatus>
<ns4:priority>High</ns4:priority>
<ns4:dateOfBirth>1965-12-09T00:00:00.000Z</ns4:dateOfBirth>
<ns4:maritalStatus>
<ns3:value>single</ns3:value>
</ns4:maritalStatus>
<ns4:type>
<ns3:value>Billing</ns3:value>
</ns4:type>
<ns4:firstNameFurigana>Jeniffer</ns4:firstNameFurigana>
<ns4:middleNameFurigana>Goldman</ns4:middleNameFurigana>
<ns4:lastNameFurigana>Francis</ns4:lastNameFurigana>
<ns4:startGreeting>Hello</ns4:startGreeting>
<ns4:endGreeting>Byee</ns4:endGreeting>
<ns4:spouseName>Sara</ns4:spouseName>
<ns4:emergencyContact>998-765-4321</ns4:emergencyContact>
<ns4:occupation>Branch Manager</ns4:occupation>
<ns4:incomeLevel>80000-90000</ns4:incomeLevel>
<ns4:educationLevel>
<ns3:value>doctorate</ns3:value>
</ns4:educationLevel>
<ns4:race>African</ns4:race>
<ns4:dependents>4</ns4:dependents>
<ns4:isSmoker>true</ns4:isSmoker>
<ns4:hobbies>Farming</ns4:hobbies>
<ns4:interests>Painting</ns4:interests>
<ns4:contactOrder>1980</ns4:contactOrder>
<ns4:customAttributes>
<ns3:customAttribute>
<ns3:attribName>isprimary</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>n</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</ns4:customAttributes>
<ns4:contactPoints>
<ns5:contactPoint>
<ns5:type>
<ns5:value>phone</ns5:value>
<ns5:phone>
<ns5:type>
<ns3:value>pager</ns3:value>
</ns5:type>
<ns5:phoneNo>234-3456</ns5:phoneNo>
<ns5:countryCode>1</ns5:countryCode>
<ns5:areaCode>408</ns5:areaCode>
<ns5:extension>102</ns5:extension>
<ns5:availability>
<ns5:days>
<ns3:value>weekends</ns3:value>
</ns5:days>
<ns5:times>
<ns3:value>day</ns3:value>
</ns5:times>
</ns5:availability>
</ns5:phone>
</ns5:type>
<ns5:priority>
<ns3:value>high</ns3:value>
</ns5:priority>
<ns5:customAttributes>
<ns3:customAttribute>
<ns3:attribName>prioritysequence</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>1</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</ns5:customAttributes>
</ns5:contactPoint>
<ns5:contactPoint>
<ns5:type>
<ns5:value>postal</ns5:value>
<ns5:postal>
<ns5:type>
<ns3:value>shipto</ns3:value>
</ns5:type>
<ns5:address_1>345</ns5:address_1>
<ns5:address_2>E Midfield Rd</ns5:address_2>
<ns5:city>Mountain View</ns5:city>
<ns5:state>CO</ns5:state>
<ns5:zip>98704</ns5:zip>
<ns5:country>USA</ns5:country>
<ns5:region>United States</ns5:region>
</ns5:postal>
</ns5:type>
<ns5:priority>
<ns3:value>high</ns3:value>
</ns5:priority>
<ns5:customAttributes>
<ns3:customAttribute>
<ns3:attribName>prioritysequence</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>2</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</ns5:customAttributes>
</ns5:contactPoint>
<ns5:contactPoint>
<ns5:type>
<ns5:value>email</ns5:value>
<ns5:email>
<ns5:emailAddress>jenniffer.goldman@customer.com</ns5:emailAddress>
</ns5:email>
</ns5:type>
<ns5:priority>
<ns3:value>medium</ns3:value>
</ns5:priority>
<ns5:customAttributes>
<ns3:customAttribute>
<ns3:attribName>prioritysequence</ns3:attribName>
<ns3:attribValues>
<ns3:attribValue>
<ns3:value>3</ns3:value>
</ns3:attribValue>
</ns3:attribValues>
</ns3:customAttribute>
</ns5:customAttributes>
</ns5:contactPoint>
</ns4:contactPoints>
</ns4:contactPerson>
</contactPersons>
</customer> Response
HTTP/1.1 201 Created
Response headers
| Name | Value |
|---|---|
| X-egain-session | current session ID |
| Content-Type | application/xml |
| Location | /system/ws/v12/interaction/customer/2807 |
Request
| Method | URL |
|---|---|
| POST | /ws/v12/interaction/customer |
Request headers
| Name | Value |
|---|---|
| X-egain-session | Valid session ID |
| Accept | application/json |
| Content-Type | application/json |
| Accept-Language | en-US |
Request body
{
"department": {
"name": "Service"
},
"type": {
"value": "group",
"group": {
"type": {
"value": "Membership"
},
"region": "Europe",
"numberOfMembers": "12",
"income": "1000000",
"currency": "USD",
"registrationNumber": "324",
"affiliation": "FCMA"
}
},
"customerName": "Unichem Laboratories Limited",
"level": {
"value": "Platinum"
},
"role": {
"value": "Partner"
},
"pin": "0121",
"howReferred": {
"value": "Customer"
},
"industry": {
"value": "Health care"
},
"marketSegment": "Medical Products",
"entitlements": "Free service",
"customAttributes": {
"customAttribute": [
{
"attribName": "preferredlang",
"attribValues": {
"attribValue": [
{
"value": "English"
}
]
}
}
]
},
"contactPersons": {
"contactPerson": [
{
"salutation": "Mr.",
"firstName": "Kriag",
"middleName": "Goldman",
"lastName": "Francis",
"loginId": "kriag",
"gender": {
"value": "male"
},
"identification": {
"type": "SSN",
"value": "111-22-8765"
},
"suffix": {
"value": "i"
},
"initials": "A.",
"secretQuestion": "Place of Birth",
"secretAnswer": "Sunnyvale",
"hasDirectMailingConsent": "true",
"hasDirectCallingConsent": "true",
"hasHoldingDataConsent": "true",
"jobTitle": "Manager",
"employmentStatus": {
"value": "full-time"
},
"priority": "High",
"dateOfBirth": "1965-12-09T00:00:00.000Z",
"maritalStatus": {
"value": "divorced"
},
"type": {
"value": "Legal"
},
"firstNameFurigana": "Kriag",
"middleNameFurigana": "Goldman",
"lastNameFurigana": "Francis",
"startGreeting": "Hey, Welcome",
"endGreeting": "Have a Nice Day!",
"spouseName": "Kethel",
"emergencyContact": "998-765-4321",
"occupation": "Branch Manager",
"incomeLevel": "40000-50000",
"educationLevel": {
"value": "graduate"
},
"race": "African",
"dependents": "4",
"isSmoker": "true",
"hobbies": "Farming",
"interests": "Painting",
"contactOrder": "1984",
"customAttributes": {
"customAttribute": [
{
"attribName": "isprimary",
"attribValues": {
"attribValue": [
{
"value": "y"
}
]
}
}
]
},
"contactPoints": {
"contactPoint": [
{
"type": {
"value": "phone",
"phone": {
"type": {
"value": "mobile"
},
"phoneNo": "234 3456",
"countryCode": "1",
"areaCode": "408",
"extension": "102",
"availability": {
"days": {
"value": "weekends"
},
"times": {
"value": "anytime"
}
}
}
},
"priority": {
"value": "high"
},
"customAttributes": {
"customAttribute": [
{
"attribName": "prioritysequence",
"attribValues": {
"attribValue": [
{
"value": "1"
}
]
}
}
]
}
},
{
"type": {
"value": "postal",
"postal": {
"type": {
"value": "billto"
},
"address_1": "345",
"address_2": "E Midfield Rd",
"city": "Mountain View",
"state": "Ca",
"zip": "98704",
"country": "USA",
"region": "United States"
}
},
"priority": {
"value": "low"
},
"customAttributes": {
"customAttribute": [
{
"attribName": "prioritysequence",
"attribValues": {
"attribValue": [
{
"value": "2"
}
]
}
}
]
}
},
{
"type": {
"value": "email",
"email": {
"emailAddress": "kriag.goldman@customer.com"
}
},
"priority": {
"value": "high"
},
"customAttributes": {
"customAttribute": [
{
"attribName": "prioritysequence",
"attribValues": {
"attribValue": [
{
"value": "3"
}
]
}
}
]
}
}
]
}
},
{
"salutation": "Mrs.",
"firstName": "Jeniffer",
"middleName": "Goldman",
"lastName": "Francis",
"loginId": "Jfrancis",
"gender": {
"value": "female"
},
"identification": {
"type": "SSN",
"value": "111-22-8766"
},
"suffix": {
"value": "sr."
},
"initials": "J.",
"secretQuestion": "Place of Birth",
"secretAnswer": "Texas",
"hasDirectMailingConsent": "false",
"hasDirectCallingConsent": "false",
"hasHoldingDataConsent": "true",
"jobTitle": "Manager",
"employmentStatus": {
"value": "contract"
},
"priority": "High",
"dateOfBirth": "1965-12-09T00:00:00.000Z",
"maritalStatus": {
"value": "single"
},
"type": {
"value": "Billing"
},
"firstNameFurigana": "Jeniffer",
"middleNameFurigana": "Goldman",
"lastNameFurigana": "Francis",
"startGreeting": "Hello",
"endGreeting": "Byee",
"spouseName": "Sara",
"emergencyContact": "998-765-4321",
"occupation": "Branch Manager",
"incomeLevel": "80000-90000",
"educationLevel": {
"value": "doctorate"
},
"race": "African",
"dependents": "4",
"isSmoker": "true",
"hobbies": "Farming",
"interests": "Painting",
"contactOrder": "1980",
"customAttributes": {
"customAttribute": [
{
"attribName": "isprimary",
"attribValues": {
"attribValue": [
{
"value": "n"
}
]
}
}
]
},
"contactPoints": {
"contactPoint": [
{
"type": {
"value": "phone",
"phone": {
"type": {
"value": "pager"
},
"phoneNo": "234-3456",
"countryCode": "1",
"areaCode": "408",
"extension": "102",
"availability": {
"days": {
"value": "weekends"
},
"times": {
"value": "day"
}
}
}
},
"priority": {
"value": "high"
},
"customAttributes": {
"customAttribute": [
{
"attribName": "prioritysequence",
"attribValues": {
"attribValue": [
{
"value": "1"
}
]
}
}
]
}
},
{
"type": {
"value": "postal",
"postal": {
"type": {
"value": "shipto"
},
"address_1": "345",
"address_2": "E Midfield Rd",
"city": "Mountain View",
"state": "CO",
"zip": "98704",
"country": "USA",
"region": "United States"
}
},
"priority": {
"value": "high"
},
"customAttributes": {
"customAttribute": [
{
"attribName": "prioritysequence",
"attribValues": {
"attribValue": [
{
"value": "2"
}
]
}
}
]
}
},
{
"type": {
"value": "email",
"email": {
"emailAddress": "jenniffer.goldman@customer.com"
}
},
"priority": {
"value": "medium"
},
"customAttributes": {
"customAttribute": [
{
"attribName": "prioritysequence",
"attribValues": {
"attribValue": [
{
"value": "3"
}
]
}
}
]
}
}
]
}
}
]
}
} Response
HTTP/1.1 201 Created
Response headers
| Name | Value |
|---|---|
| X-egain-session | current session ID |
| Content-Type | application/json |
| Location | /system/ws/v12/interaction/customer/2808 |