Get Group
Type : Get
Endpoint : https://api.salesandmarketing.ai/v1/group/getGroupList
Description : Retrieves a list of groups.
Header example :
{
"secretKey": "YourSecretKey",
"authToken": "YourAuthToken"
}Response example :
{
"status": 200,
"message": "Group Fetched Successfully.",
"result": {
"totalContact": 2,
"group": [
{
"groupId": 1,
"groupName": "Group 1"
},
{
"groupId": 2,
"groupName": "Group 2"
}
]
}
}Save Group
Type : Post
Endpoint : https://api.salesandmarketing.ai/v1/group/saveGroup
Description : Saves a new group or updates an existing group.
Request :
groupId : Unique identifier for the group (0 for new group).
groupName : Name of the group.
memberId : ID of the member.
subMemberId : ID of the sub-member.
udfs : Array of user-defined fields with id and udf. id is the unique identifier for the field (0 for new field) and udf is the value of the field. Blank array for no user-defined fields.
Header example :
{
"secretKey": "YourSecretKey",
"authToken": "YourAuthToken"
}Request sample :
{
"groupId": 0,
"groupName": "Group 1",
"memberId": 1,
"subMemberId": 0,
"udfs": [
{
"id": 0,
"udf": "Salary"
}
]
}Response example :
{
"status": 200,
"message": "Add Group Successfully.",
"result": {}
}Delete Group
Type : Delete
Endpoint : https://api.salesandmarketing.ai/v1/group/deleteBulkGroup
Description : Deletes multiple or single group(s).
Request :
groupIds : Array of group ID(s) to be deleted.
Header example :
{
"secretKey": "YourSecretKey",
"authToken": "YourAuthToken"
}Request sample :
{
"groupIds": [
1,
2
]
}Response example :
{
"status": 200,
"message": "Group Deleted Successfully.",
"result": {}
}Get Contacts
Type : Get
Endpoint : https://api.salesandmarketing.ai/v1/contact/getContactList/{groupId}?searchKey={keyword}&page={page}&size={size}&sort={columnName,order}
Description : Retrieves a list of contacts.
URL Parameters :
groupId : Group ID to filter contacts,
keyword : Search keyword for contacts,
page : Current page number,
size : Contacts per page,
columnName : Column to sort by, format: "columnName,asc|desc".
order : Order of sorting, format: "columnName,asc|desc".
Header example :
{
"secretKey": "YourSecretKey",
"authToken": "YourAuthToken"
}Response example :
{
"status": 200,
"message": "Contact Fetched Successfully.",
"result": {
"contactHeader": {
"birthday": "Birthday",
"lastName": "Last Name",
"country": "Country",
"emailDomain": "Email Domain",
"gender": "Gender",
"city": "City",
"dateRegistered": "Registered Date",
"zipPostalCode": "Zip Code",
"smsStatus": "SMS Status",
"optBackInDate": "Opt Back In Date",
"usDefaultLanguage": "Language",
"email": "Email",
"stateProvRegion": "State",
"streetAddress1": "Street Address1",
"fullName": "Full Name",
"streetAddress2": "Street Address2",
"udf3": "Exp. Date",
"udf1": "Promo Item",
"udf2": "Discount",
"optOutDate": "Opt Out Date",
"tags": "Tags",
"firstName": "First Name",
"phoneNumber": "Mobile",
"optDate": "Opt Date",
"phone": "Phone",
"status": "Status"
},
"getNumber": 0,
"totalContact": 1,
"getSize": 25,
"contact": [
{
"emailId": 1,
"memberId": 20,
"firstName": "John",
"lastName": "Smith",
"birthday": "",
"email": "john@company.com",
"country": "USA",
"phoneNumber": null,
"subMemberId": 0,
"groupId": 5,
"streetAddress1": null,
"age": 0.0,
"badEmail": "",
"badPhoneNumber": "N",
"bounceReason": "",
"cc": null,
"city": null,
"confirmIP": null,
"contactRating": null,
"dstOff": null,
"emailDomain": "company.com",
"emailClientUsed": null,
"emailLists": null,
"emailPermissionStatusOther": null,
"euid": null,
"gender": null,
"gmtOff": null,
"isEmailValidate": "Y",
"isChecked": null,
"jobTitle": null,
"latitude": null,
"leid": null,
"longitude": null,
"notes": null,
"optId": null,
"optInIPAddress": null,
"optOutIpAddress": null,
"region": null,
"selectDateFormat": null,
"signupSource": null,
"smsSid": null,
"smsStatus": "Subscribed",
"stateProvRegion": null,
"status": "Subscribed",
"storeCustomerId": null,
"streetAddress2": null,
"fullName": "John Smith",
"phone": null,
"tags": null,
"tempCronId": null,
"timeZone": null,
"udf1": null,
"udf10": null,
"udf2": null,
"udf3": null,
"udf4": null,
"udf5": null,
"udf6": null,
"udf7": null,
"udf8": null,
"udf9": null,
"usDefaultLanguage": "en",
"zipPostalCode": null,
"duplicateRecords": "N",
"reCaptchaToken": null,
"dateRegistered": "06/19/2020",
"optDate": null,
"optBackInDate": null,
"optOutDate": null,
"dateAdded": "06/19/2020",
"dateLastModified": "06/19/2020",
"confirmDateTime": null,
"udfs": null,
"countryCode": null,
"optInType": null,
"encEmailId": "JWHGItiMew==",
"typeEmail": "unverified",
"typeSms": "done",
"sendToEmailVerification": "No"
}
],
"contactHeaderKey": [
"firstName",
"lastName",
"fullName",
"email",
"phoneNumber",
"phone",
"usDefaultLanguage",
"streetAddress1",
"streetAddress2",
"city",
"stateProvRegion",
"zipPostalCode",
"country",
"birthday",
"gender",
"emailDomain",
"dateRegistered",
"status",
"smsStatus",
"optDate",
"optBackInDate",
"optOutDate",
"tags",
"udf1",
"udf2",
"udf3"
],
"getTotalPages": 1
}
}Add Contact
Type : Post
Endpoint : https://api.salesandmarketing.ai/v1/contact/addContact
Description : Adds a new contact.
Request :
fullName : Full name of the contact (optional).
usDefaultLanguage : Default language of the user (optional).
optInType : Type of opt-in (optional).
country : Country of the contact (optional).
firstName : First name of the contact (optional).
lastName : Last name of the contact (optional).
email : Email address of the contact.
phoneNumber : Phone number of the contact.
phone : Alternate phone number (optional).
gender : Gender of the contact (optional).
birthday : Birthday of the contact (optional).
stateProvRegion : State/Province/Region of the contact (optional).
streetAddress1 : Street address 1 of the contact (optional).
streetAddress2 : Street address 2 of the contact (optional).
city : City of the contact (optional).
zipPostalCode : ZIP/Postal code of the contact (optional).
groupId : Group ID of the contact (optional).
udf1 : User-defined field 1 (optional).
Note : All fields marked as (optional) are not mandatory for the request. email or phoneNumber is required to add a contact.
Header example :
{
"secretKey": "YourSecretKey",
"authToken": "YourAuthToken"
}Request sample :
{
"fullName": "John Simth",
"usDefaultLanguage": "en",
"optInType": "",
"country": "United States",
"firstName": "John",
"lastName": "Simth",
"email": "smith@company.com",
"phoneNumber": "9547988905",
"phone": "9037988541",
"gender": "Male",
"birthday": "11/02/1981",
"stateProvRegion": "California",
"streetAddress1": "address 1",
"streetAddress2": "address 2",
"city": "Brooking",
"zipPostalCode": "97201",
"groupId": "821",
"udf1": "10%",
"emailId": 0,
"memberId": 1,
"subMemberId": 0
}Response example :
{
"status": 200,
"message": "Contact Added",
"result": {
"userlist": {
"emailId": 1,
"memberId": 1,
"firstName": "John",
"lastName": "Simth",
"birthday": "JwReTXBaulI31w==",
"email": "ZcfjLEC/YZohmIX9EKmAvKw=",
"country": "United States",
"phoneNumber": "9547988905",
"subMemberId": 0,
"groupId": 821,
"streetAddress1": "address 1",
"age": 0.0,
"badEmail": "N",
"badPhoneNumber": "N",
"bounceReason": null,
"cc": null,
"city": "Brooking",
"confirmIP": null,
"contactRating": null,
"dstOff": null,
"emailDomain": "company.com",
"emailClientUsed": null,
"emailLists": null,
"emailPermissionStatusOther": null,
"euid": null,
"gender": "Male",
"gmtOff": null,
"isEmailValidate": "N",
"isChecked": null,
"jobTitle": null,
"latitude": null,
"leid": null,
"longitude": null,
"notes": null,
"optId": null,
"optInIPAddress": null,
"optOutIpAddress": null,
"region": null,
"selectDateFormat": null,
"signupSource": null,
"smsSid": null,
"smsStatus": "Subscribed",
"stateProvRegion": "California",
"status": "Subscribed",
"storeCustomerId": null,
"streetAddress2": "address 2",
"fullName": "John Simth",
"phone": "9037988541",
"tags": null,
"tempCronId": null,
"timeZone": null,
"udf1": null,
"udf10": null,
"udf2": "10%",
"udf3": null,
"udf4": null,
"udf5": null,
"udf6": null,
"udf7": null,
"udf8": null,
"udf9": null,
"usDefaultLanguage": "en",
"zipPostalCode": "97201",
"duplicateRecords": null,
"reCaptchaToken": null,
"dateRegistered": "08/05/2025",
"optDate": null,
"optBackInDate": null,
"optOutDate": null,
"dateAdded": "08/05/2025",
"dateLastModified": "08/05/2025",
"confirmDateTime": null,
"udfs": null,
"countryCode": null,
"optInType": null,
"encEmailId": null,
"typeEmail": "unverified",
"typeSms": "done",
"sendToEmailVerification": "No"
},
"error": ""
}
}Update Contact
Type : Put
Endpoint : https://api.salesandmarketing.ai/v1/contact/updateContact/{emailId}
Description : Updates the contact information.
URL Parameters :
emailId : Email ID of the contact to be updated.
Request :
emailId : Email ID of the contact (required).
memberId : Member ID of the contact (required).
firstName : First name of the contact (optional).
lastName : Last name of the contact (optional).
birthday : Birthday of the contact (optional).
email : Email address of the contact (optional).
country : Country of the contact (optional).
phoneNumber : Phone number of the contact (optional).
subMemberId : Sub-member ID (optional).
groupId : Group ID of the contact (optional).
streetAddress1 : Street address 1 of the contact (optional).
age : Age of the contact (optional).
badEmail : Bad email status (optional).
badPhoneNumber : Bad phone number status (optional).
bounceReason : Bounce reason (optional).
cc : CC email addresses (optional).
city : City of the contact (optional).
confirmIP : Confirmation IP address (optional).
contactRating : Contact rating (optional).
dstOff : Daylight saving time offset (optional).
emailDomain : Email domain of the contact (optional).
emailClientUsed : Email client used (optional).
emailLists : Email lists (optional).
emailPermissionStatusOther : Other email permission status (optional).
euid : EUID (optional).
gender : Gender of the contact (optional).
gmtOff : GMT offset (optional).
isEmailValidate : Email validation status (optional).
isChecked : Email validation status (optional).
jobTitle : Job title of the contact (optional).
latitude : Latitude of the contact (optional).
leid : LEID (optional).
longitude : Longitude of the contact (optional).
notes : Notes about the contact (optional).
optId : Opt-in ID (optional).
optInIPAddress : Opt-in IP address (optional).
optOutIpAddress : Opt-out IP address (optional).
region : Region of the contact (optional).
selectDateFormat : Date format selection (optional).
signupSource : Source of signup (optional).
smsSid : SMS SID (optional).
smsStatus : SMS status (optional).
stateProvRegion : State/Province/Region of the contact (optional).
status : Status of the contact (optional).
storeCustomerId : Store customer ID (optional).
streetAddress2 : Street address 2 of the contact (optional).
fullName : Full name of the contact (optional).
phone : Alternate phone number (optional).
tags : Tags associated with the contact (optional).
tempCronId : Temporary cron ID (optional).
timeZone : Time zone of the contact (optional).
udf1 : User-defined field 1 (optional).
udf10 : User-defined field 10 (optional).
udf2 : User-defined field 2 (optional).
udf3 : User-defined field 3 (optional).
udf4 : User-defined field 4 (optional).
udf5 : User-defined field 5 (optional).
udf6 : User-defined field 6 (optional).
udf7 : User-defined field 7 (optional).
udf8 : User-defined field 8 (optional).
udf9 : User-defined field 9 (optional).
usDefaultLanguage : Default language of the user (optional).
zipPostalCode : ZIP/Postal code of the contact (optional).
duplicateRecords : Duplicate records status (optional).
reCaptchaToken : reCAPTCHA token (optional).
dateRegistered : Date of registration (optional).
optDate : Opt-in date (optional).
optBackInDate : Opt-back-in date (optional).
optOutDate : Opt-out date (optional).
dateAdded : Date added (optional).
dateLastModified : Date last modified (optional).
confirmDateTime : Confirmation date and time (optional).
udfs : Array of user-defined fields with id and udf. id is the unique identifier for the field (0 for new field) and udf is the value of the field. Blank array for no user-defined fields.
countryCode : Country code (optional).
optInType : Type of opt-in (optional).
encEmailId : Encrypted email ID (optional).
typeEmail : Type of email (optional).
typeSms : Type of SMS (optional).
sendToEmailVerification : Send to email verification (optional).
Header example :
{
"secretKey": "YourSecretKey",
"authToken": "YourAuthToken"
}Request sample :
{
"emailId": 1,
"memberId": 1,
"firstName": "John",
"lastName": "Simth",
"birthday": "11/02/1981",
"email": "smith@company.com",
"country": "United States",
"phoneNumber": "9547988905",
"subMemberId": 0,
"groupId": 821,
"streetAddress1": "address 1",
"age": 0,
"badEmail": "N",
"badPhoneNumber": "N",
"bounceReason": null,
"cc": null,
"city": "Brooking",
"confirmIP": null,
"contactRating": null,
"dstOff": null,
"emailDomain": "company.com",
"emailClientUsed": null,
"emailLists": null,
"emailPermissionStatusOther": null,
"euid": null,
"gender": "Male",
"gmtOff": null,
"isEmailValidate": "N",
"isChecked": null,
"jobTitle": null,
"latitude": null,
"leid": null,
"longitude": null,
"notes": null,
"optId": null,
"optInIPAddress": null,
"optOutIpAddress": null,
"region": null,
"selectDateFormat": null,
"signupSource": null,
"smsSid": null,
"smsStatus": "Subscribed",
"stateProvRegion": "California",
"status": "Subscribed",
"storeCustomerId": null,
"streetAddress2": "address 2",
"fullName": "John Simth",
"phone": "9037988541",
"tags": null,
"tempCronId": null,
"timeZone": null,
"udf1": null,
"udf10": null,
"udf2": "10%",
"udf3": null,
"udf4": null,
"udf5": null,
"udf6": null,
"udf7": null,
"udf8": null,
"udf9": null,
"usDefaultLanguage": "en",
"zipPostalCode": "97201",
"duplicateRecords": null,
"reCaptchaToken": null,
"dateRegistered": "08/05/2025",
"optDate": null,
"optBackInDate": null,
"optOutDate": null,
"dateAdded": "08/05/2025",
"dateLastModified": "08/05/2025",
"confirmDateTime": null,
"udfs": null,
"countryCode": null,
"optInType": null,
"encEmailId": null,
"typeEmail": "unverified",
"typeSms": "done",
"sendToEmailVerification": "No"
}Response example :
{
"status": 200,
"message": "Contact Updated Successfully.",
"result": {
"emailId": 1,
"memberId": 1,
"firstName": "John",
"lastName": "Simth",
"birthday": "JwReTXBaulI31w==",
"email": "ZcfjLEC/YZohmIX9EKmAvKw=",
"country": "United States",
"phoneNumber": "9547988905",
"subMemberId": 0,
"groupId": 821,
"streetAddress1": "address 1",
"age": 0.0,
"badEmail": "N",
"badPhoneNumber": "N",
"bounceReason": null,
"cc": null,
"city": "Brooking",
"confirmIP": null,
"contactRating": null,
"dstOff": null,
"emailDomain": "company.com",
"emailClientUsed": null,
"emailLists": null,
"emailPermissionStatusOther": null,
"euid": null,
"gender": "Male",
"gmtOff": null,
"isEmailValidate": "Y",
"isChecked": null,
"jobTitle": null,
"latitude": null,
"leid": null,
"longitude": null,
"notes": null,
"optId": null,
"optInIPAddress": null,
"optOutIpAddress": null,
"region": null,
"selectDateFormat": null,
"signupSource": null,
"smsSid": null,
"smsStatus": "Subscribed",
"stateProvRegion": "California",
"status": "Subscribed",
"storeCustomerId": null,
"streetAddress2": "address 2",
"fullName": "John Simth",
"phone": "9037988541",
"tags": null,
"tempCronId": null,
"timeZone": null,
"udf1": null,
"udf10": null,
"udf2": "10%",
"udf3": null,
"udf4": null,
"udf5": null,
"udf6": null,
"udf7": null,
"udf8": null,
"udf9": null,
"usDefaultLanguage": "en",
"zipPostalCode": "97201",
"duplicateRecords": null,
"reCaptchaToken": null,
"dateRegistered": "08/05/2025",
"optDate": null,
"optBackInDate": null,
"optOutDate": null,
"dateAdded": "08/05/2025",
"dateLastModified": "08/05/2025",
"confirmDateTime": null,
"udfs": null,
"countryCode": null,
"optInType": null,
"encEmailId": null,
"typeEmail": "unverified",
"typeSms": "done",
"sendToEmailVerification": "No"
}
}Delete Contacts
Type : Delete
Endpoint : https://api.salesandmarketing.ai/v1/contact/deleteBulkContact
Description : Deletes multiple or single contact(s).
Request :
emailIds : Array of email ID(s) to be deleted.
Header example :
{
"secretKey": "YourSecretKey",
"authToken": "YourAuthToken"
}Request sample :
{
"emailIds": [
1,
2
]
}Response example :
{
"status": 200,
"message": "Contact Deleted Successfully.",
"result": {}
}