Bold360 and BoldChat Developer Center

getContact

Returns full detail for a specified contact.

Input parameter

Parameter Type Required Description
ContactID numeric - ID code Yes The identifier of the contact to retrieve

Request format

curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getContact?auth=$authHash&ContactID=$ContactID"

Return values

Parameters are provided in alphabetic order. See Sample code for probable output.

Parameter Type Description
AccountID numeric - ID code Bold360 product account ID.
Address1 string Street address - first line.
Address2 string Street address - line 2.
Business Name string Name of customer business.
City string - ISO 3166 City of the visitor or customer.
ContactID numeric - ID code ID assigned to the contact.
CountryCode code - ISO 3166 ISO 2-letter country code (e.g. US).
Created date - ISO/UTC Date and time when the contact was created.
CreatedByOperatorID numeric - ID code Operator who created the record.
CustomField1ID numeric - ID code ID of the Custom Field 1 label applied to a chat during post-chat wrap-up. Retrievable using FolderType=32. <None> or null refers to no Custom Field 1 label present on a chat.
CustomField2ID numeric -ID code ID of the Custom Field 2 label applied to a chat during post-chat wrap-up. Retrievable using FolderType=33. <None> or null refers to no Custom Field 2 label present on a chat.
Data text - heading JSON array heading that precedes report data output.
Deleted date - ISO / UTC Date and time when the item was deleted. The value is null if the item was not deleted.
DeletedBy string (max) The name of the agent who deleted the item. <None> or null value indicates that the <resource> was not deleted.
DepartmentID numeric - ID code ID of the department.
DueDate date - ISO / UTC Not in use - parameter is obsolete.
FirstName string First name of the contact.
Flagged Boolean Indicates whether the chat flag was raised within Bold360.
FolderID numeric The ID of the folder.
FullName string Full name of the contact.
InternalPhoneNumber string - legal phone number Phone number for the account.
LastAssignedByOperatorID numeric - ID code ID of the agent who most recently assigned the chat. Null value indicates that the agent has not reassigned the chat.
LastName string Last name of the customer (e.g. from pre-chat form).
Notes string Text container for notes.
OperatorID numeric - ID code System-assigned ID of the operator.
PostalCode code - ISO 3166 International post codes including, for example, ZIP codes.
PrimaryEmailAddress string - legal email Contact's primary email address.
PrimaryPhoneExtension string Contact's telephone extension
PrimaryPhoneNumber string - legal phone number Contact's primary telephone
PrimaryUserName string Contact's preferred user name.
State code - ISO 3166 Contact's state/province.
Status codes - set values "Success" when the call completes; "Error" when the call fails.
Updated date - ISO / UTC Date and time when the <event/record> was most recently modified.
UserCategoryID numeric - ID code ID of the User Category applied to a chat during post-chat wrap-up. <None> or null refers to no User Category present on a chat.
UserStatusID numeric - ID code ID of the user status applied to a chat during post-chat wrap-up. <None> or null indicates that there is no user status present on a chat.
WebsiteUrl string - legal URL Contact's company website.

Sample code

{
    "Status": "success",   
    "Data": {
        "UserStatusID": null,
        "InternalPhoneNumber": "",
        "CustomField2ID": null,
        "PrimaryUserName": "",
        "LastAssignedByOperatorID": "5676748830204723022",
        "DeletedBy": null,
        "BusinessName": "",
        "Updated": "2019-01-16T13:56:49.117Z",
        "WebsiteUrl": "",
        "City": "",
        "CreatedByOperatorID": "5676748830204723022",
        "State": "",
        "PrimaryPhoneNumber": "",
        "LastName": "TESTLN",
        "PostalCode": "",
        "OperatorID": null,
        "FolderID": "622107834439872219",
        "Created": "2018-06-08T19:17:22.360Z",
        "PrimaryPhoneExtension": "",
        "CustomField1ID": null,
        "DepartmentID": null,
        "Deleted": null,
        "CountryCode": null,
        "DueDate": null,
        "Notes": "",
        "UserCategoryID": null,
        "AccountID": "627499986405274345",
        "FirstName": "TEST",
        "Address2": "",
        "ContactID": "1681073016909011362",
        "Address1": "",
        "PrimaryEmailAddress": "schumpeter@gmail.com",
        "FullName": "Simpson",
        "Flagged": null
    }
}