06-30-2023 07:58 AM
Query 1: Is it possible to list all of the customer profiles?
Looking at the Customer Profile API - it doesn't see a way to retrieve all, i.e. list customer profiles.
Here is an example where you can retrieve multiple customer IDs - how do retrieve all profiles?
https://api.eu.webexconnect.io/resources/v2/customerprofile?customerId=100&customerId=101&customerId=102&customerId=103
Query 2: Is it possible to set a custom attribute to a customer profile?
only the following attributes seem possible? name, email and msisdn (as well as customerId).
In the API doc the example responses contain other attributes such as "sms", "fb" etc.
I tried setting the sms attribute to "1" and it didn't work?
If you set "sms" to 0 or 1 (i.e. integers and not strings - "0" and "1") - it returns
"invalid value for attribute sms, only values [0,1] are allowed",
But if you set to "0" or "1" it responds with "description": "Profile attribute doesn't exist"
What I would ideally like is the ability to add a custom attribute and to be able to list all customer profiles who have a customer attribute = "x".
Profile Node
Reference: https://help.imiconnect.io/docs/profile-node
Get Profile
Reference: https://developers.imiconnect.io/reference/getprofile
Note - the API documentation as a number of issues.
1) It incorrectly states the API header key is "secretKey" instead of "key" for Profile APIs
2) It doesn't give examples which would be helpful. i.e. Create Customer Profile (note the Postman collections has examples)
3) Not related to the Profile API - but both the Topic and Segment API "Postman collection" link are not working.
Regards,
Gerry
Solved! Go to Solution.
07-04-2023 08:33 AM
Hi Gerry,
Please find below the response to your questions:
Query 1: No, we don't provide any API to get the list of all customer profiles because typically clients would use their business specific unique customer identities as the customer ID and hence they must pass the desired set of customer IDs to retrieve the profile data.
Query 2: Only custom parameters related to the channels that are supported by Webex Connect can be introduced in customer profile. You will need to raise a support ticket to get it added to the schema of customer profile. Once this step is done, you can include these parameters while creating a customer profile.
Regarding notes on documentation:
1. We have passed this feedback to our documentation team and they will be addressing the issue.
2. Example of Create Customer Profile API is present in the documentation. To access the sample, you need to select cURL as the Library and one of the Request Example types as highlighted in the screenshot below in red:
We will review if this can be made the default configuration so that the examples are more visible.
3. In the overview page of Topic or Segment APIs On clicking the 'Run in Postman' button, you should be redirected to the postman collection for Topics and Segments APIs.
Thanks
Arindam
07-04-2023 08:33 AM
Hi Gerry,
Please find below the response to your questions:
Query 1: No, we don't provide any API to get the list of all customer profiles because typically clients would use their business specific unique customer identities as the customer ID and hence they must pass the desired set of customer IDs to retrieve the profile data.
Query 2: Only custom parameters related to the channels that are supported by Webex Connect can be introduced in customer profile. You will need to raise a support ticket to get it added to the schema of customer profile. Once this step is done, you can include these parameters while creating a customer profile.
Regarding notes on documentation:
1. We have passed this feedback to our documentation team and they will be addressing the issue.
2. Example of Create Customer Profile API is present in the documentation. To access the sample, you need to select cURL as the Library and one of the Request Example types as highlighted in the screenshot below in red:
We will review if this can be made the default configuration so that the examples are more visible.
3. In the overview page of Topic or Segment APIs On clicking the 'Run in Postman' button, you should be redirected to the postman collection for Topics and Segments APIs.
Thanks
Arindam
07-04-2023 09:12 AM
Thanks for your response Arindam.
It would be a nice feature enhancement to be able to list profiles (using pagination and be able to filter / search responses as well - but thank you for confirming it not available today).
Yes - when I change from Library from 'default' to 'curl' I can now see the example. Thank you.
> We will review if this can be made the default configuration so that the examples are more visible.
Sounds great! Thanks.
>3. In the overview page of Topic or Segment APIs On clicking the 'Run in Postman' button, you should be redirected to the postman collection for Topics and Segments APIs.
This doesn't work - give it a go. Segment and Topic Postman collections redirect to an invalid page - and not to postman collection. Example:
Segment Link: https://developers.imiconnect.io/reference/overview-4
Which redirects to the following postman link - which is not valid:
https://www.postman.com/collections/74223e5b2c18d5b4d0c6
Regards,
Gerry
07-04-2023 04:28 AM
Anyone know if above is possible?
Discover and save your favorite ideas. Come back to expert answers, step-by-step guides, recent topics, and more.
New here? Get started with these tips. How to use Community New member guide