7. API get segment
URL: https://apiring.antbuddy.com/segments/set-contact
Method: POST
Content-Type: application/json Limit 100 contacts per request
Body: { contacts: [{customer data A}, {customer data B}], segmentId: “CRM segment id”
}
Parameters
Type
Required
Explain
name
string
AND
Customer name
customerIdApiRing
string
N
Customer's code
type
string
Customer Type. (0: contact, 1: account). Default is
0
contactType
string
“lead" or “customer". Default is lead
dateOfBirth
string
Date of birth. (“March 15, 2000”)
gender
string
Sex. (0: Male, 1: Female, 2: Other). Default is 2
dateOfBirth
string
Date of birth. (“March 15, 2000”)
gender
string
Sex. (0: Male, 1: Female, 2: Other). Default is 2
addresses
array
Customer address.
[{ city: "Ho Chi Minh City", state: "Tan Binh District", street: "319", (house number) streetName: "Nguyen Kiem", wards: "Ward 12",
"country": {
"code": "VN",
"name": "Vietnam" }
}]
Record the same as the address on the system.
phone
array
Phone number.
[{type:”Work”, value: “01223223”} ]
emails
array
Phone number.
[{type:”Work”, value: “01223223”} ]
industry
string
Industry (“Real Estate”)
in the
array
Social network.
[{protocol: “Facebook”, “value”: “https://abc.com”}]
bgInfo
string
Note. (“VIP Customer”)
stage
string
Status. ("A new customer")
tags
string
Label.
[ “Not yet contacted”, “Contacted” ]
sourceContact
string
Contact source. ("Advertisement")
cusFields
array
Custom fields on AntCRM.
[
{ name: "Shipping unit", value: “Fast delivery”
}
]
Results returned:
HTTP Response Code: 200
Response: Ok
Last updated