Purpose
The newcontact API is used to create a new contact in the tenant.
UI Reference: The API is called when the Create Contact button is clicked on the New Contact page.
URI: webapp-api-custinfo?api=newcontact
access Rights Required: All agent types are allowed to use this endpoint.
Request
The request contains the values for the contact, such as their name and email address.
Request Parameter
Name |
Type |
Description |
|---|---|---|
details |
object |
This parameter represents the user’s personal details in the form of properties. |
details[].properties |
Array |
This parameter represents a list of properties and values of contact details. |
details[].properties[].propertyID |
String |
This returns the id of property. |
details[].properties[].propertyName |
String |
This returns name of property |
details[].properties[].values |
Array |
This returns multiple values of property |
details[].properties[].values[].value |
String |
This returns single value of property |
details[].setLogins |
Boolean |
This indicates whether the contact has set the login value or not. |
details[].logins |
Array |
This property has a list of objects with login details including name and type of property value. |
details[].logins[].name |
String |
The vale for the login. |
details[].logins[].type |
String |
The type of login (blank, email, bounced, or Google). |
membership |
Array |
This parameter represents the membership choosed or associated with the user. |
Request Payload Example
{ |
Response
The response provides the ID of the contact that was created.
Response Parameter
Name |
Type |
Description |
|---|---|---|
errors |
Array |
An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error. |
errorDetails |
Array |
An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered. |
contactID |
String |
The ID assigned to the new contact. |
Response Payload Example
{ |
