Add Voters Custom Data Fields via API

Table of Contents

Not all customers are created equal. Sometimes there’s a specific user group you want to focus on. Here are some examples:

Paying customers
Churned customers
Customers who signed up in the last 6 months
Users billing cycle

Start to get users metadata to see feedback based on priority user groups (e.g. Paying, Churned, VIP, etc.)

You can pass different users’ data into Ducalis, check this data on Voters’ List, create filters based on this information.

How it Works

User data is fed into Ducalis using any of the following methods:

Widget
Ducalis API (this article tells about it)

Authorization

Base URL API Ducalis – https://ducalis.io/api/.

Every API request must be sent with an authorization token. There two methods that can be used to send the authorization token:

Query by the token parameter. For example, https://ducalis.io/api/boards?token=XXXXXX.
Authorization header with Bearer xxxxx content For example:

curl --location --request POST 'https://ducalis.io/api/boards' \
--header 'Authorization: Bearer YOUR_TOKEN_HERE' \
--header 'Content-Type: application/json' \
--data-raw '[
   "test1@ducalis.io",
   "test2@ducalis.io"
]'

The token for authorization of API requests can be obtained here:

Pagination and Rate limits

Each request gets a list with a limit of 100 objects by default. The maximum limit is 500 objects. To change the limit, you need to specify the parameter per-page in the request. For example https://ducalis.io/api/boards?per-page=20.

To specify a page, you must use the parameter page. For example, https://ducalis.io/api/boards?page=2.

User Data Management

Users can create posts, votes, and comments. The API allows you to fetch a specific user and get users’ metadata.

Creating/changing a user

Request POST users

Request example:

{
    "id":1,
    "name":"User Name",
    "email":"user@gmail.com",
    "avatar":"avatar_url",
    "hash":"57f04966ae362410437611bac8619c4ffc7d27sdf",
    "company":{
        "id":"1",
        "name":"Company Name",
        "custom_fields":{
            "created_at":"2019-05-06T15:00:23+00:00",
            "users_count":12,
            "paying_now":true,
            "monthly_amount":0,
            "plan_name":"Demo",
            "annual_plan":false,
            "subscription_start":"2020-08-07T10:39:29+00:00"
        }
    }
}

The User Object

Field	Description
id	User ID
email	User email
name	User name
avatar	User avatar
hash	Hash (see Docs)
company	Company object
company.id	Company ID
company.name	Company name
company.custom_fields	The list of custom fields (see Docs)

The response from the server will be empty.

Removing a User

Request DELETE users

Parameters:

Field	Description
email	User Email

Request example:

curl --location --request DELETE 'https://ducalis.io/api/users?token=YOUR_TOKEN_HERE' \
--header 'Content-Type: application/json' \
--data-raw '{"widget_user_email":"email@user.com"}'

The response from the server will be empty.

As that data is passed into Ducalis, you can filter feedback using your customers’ metadata.

Next Steps:

Manage users subscriptions via Open API
Manage users subscriptions via .csv

Updated on April 21, 2023

Was this article helpful?

Yes No