User

Manage user-related functionalities, including social login, password management, account actions, authentication, OTP handling, profile updates, customer management, session management, platform configuration, user group management, and user attribute definition.

Customer

Manage customer interactions within the application, including retrieving customer data, getting specific customers via various identifiers such as mobile numbers, emails, user IDs, or usernames, creating new customer with either email or mobile numbers, as configured within the platform, controlling access by blocking or unblocking user with reason provided, archiving and restoring customer data, and updating customer information.

Operations

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/list

# Get a List of Users

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/search

# Search an Existing Users

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers

# Create User

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/activation

# Block/Unblock Users

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/undelete

# Restore Deleted User

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/{user_id}

# Update User Details

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/archive

# Archive User

GET

Get a List of Users

Retrieve details of users registered in the sales channel

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

string

The search query. Mobile number or email ID of a customer.

page_size

integer

The number of items to retrieve in each page. Default value is 10.

Default Value : 10

page_no

integer

The page number to navigate through the given set of results. Default value is 1.

Default Value : 1

Response

200

400

Success. Refer `CustomerListResponseSchema` for more details.

CustomerListResponseSchema

items

array of object (UserSearchSchema)

Array of UserSearchSchema

application_id

string

user_id

string

first_name

string

meta

object

last_name

string

phone_numbers

array of object (PhoneNumber)

Array of PhoneNumber

phone

string

Phone number of the user.

country_code

integer

Country code for mobile number.

active

boolean

Is the phone number active.

primary

boolean

Is it a primary phone number.

verified

boolean

Is the phone number verified.

emails

array of object (Email)

Array of Email

string

Email address.

active

boolean

Is the email active.

primary

boolean

Is it a primary email.

verified

boolean

Is the email verified.

gender

string

dob

string

active

boolean

profile_pic_url

string

username

string

account_type

string

_id

string

created_at

string

updated_at

string

external_id

string

rr_id

string

Search an Existing Users

Search and filter users details registered in the sales channel

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

string

The search query. Mobile number or email ID of a customer.

query

array of string

The search queries. Mobile numbers or email IDs of customers.

Response

200

Success. Returns first name, last name, emails, phone number and gender of the user. Refer `UserSearchResponseSchema` for more details.

UserSearchResponseSchema

users

array of object (UserSearchSchema)

Array of UserSearchSchema

application_id

string

user_id

string

first_name

string

meta

object

last_name

string

phone_numbers

array of object (PhoneNumber)

Array of PhoneNumber

phone

string

Phone number of the user.

country_code

integer

Country code for mobile number.

active

boolean

Is the phone number active.

primary

boolean

Is it a primary phone number.

verified

boolean

Is the phone number verified.

emails

array of object (Email)

Array of Email

string

Email address.

active

boolean

Is the email active.

primary

boolean

Is it a primary email.

verified

boolean

Is the email verified.

gender

string

dob

string

active

boolean

profile_pic_url

string

username

string

account_type

string

_id

string

created_at

string

updated_at

string

external_id

string

rr_id

string

Create User

Parameters

company_id

string

Required

Company ID

application_id

string

Required

Application ID

Request body

phone_number

string

Required

string

first_name

string

last_name

string

gender

string

username

string

Required

meta

object

external_id

string

rr_id

string

Response

200

400

User create

CreateUserResponseSchema

user

object (UserSchema)

UserSchema

application_id

string

user_id

string

first_name

string

meta

object

last_name

string

phone_numbers

array of object (PhoneNumber)

Array of PhoneNumber

phone

string

Phone number of the user.

country_code

integer

Country code for mobile number.

active

boolean

Is the phone number active.

primary

boolean

Is it a primary phone number.

verified

boolean

Is the phone number verified.

emails

array of object (Email)

Array of Email

string

Email address.

active

boolean

Is the email active.

primary

boolean

Is it a primary email.

verified

boolean

Is the email verified.

gender

string

dob

string

active

boolean

profile_pic_url

string

username

string

account_type

string

_id

string

created_at

string

updated_at

string

external_id

string

rr_id

string

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

body:

body

Was this section helpful?

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers

Response

PUT

Block/Unblock Users

Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked accounts.

Parameters

company_id

string

Required

Company ID

application_id

string

Required

Application ID

Request body

status

boolean

user_id

array of string

reason

string

Response

200

400

Success

BlockUserSuccess

success

boolean

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

body:

body

Was this section helpful?

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/activation

Response

PUT

Restore Deleted User

Restore a previously deleted user account.

Parameters

company_id

string

Required

Company ID

application_id

string

Required

Application ID

Request body

user_id

string

reason

string

reason_id

string

Response

200

400

Success

UnDeleteUserSuccess

success

boolean

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

body:

body

Was this section helpful?

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/undelete

Response

PUT

Update User Details

Modify and update user profile information.

Parameters

company_id

string

Required

Company ID

application_id

string

Required

Application ID

user_id

string

Required

User ID

Request body

first_name

string

last_name

string

gender

string

external_id

string

rr_id

string

meta

object

phone_numbers

array of object (UserPhoneNumbers)

Array of UserPhoneNumbers

active

boolean

primary

boolean

verified

boolean

phone

string

country_code

string

emails

array of object (UserEmails)

Array of UserEmails

active

boolean

primary

boolean

verified

boolean

string

Response

200

400

User update

CreateUserResponseSchema

user

object (UserSchema)

UserSchema

application_id

string

user_id

string

first_name

string

meta

object

last_name

string

phone_numbers

array of object (PhoneNumber)

Array of PhoneNumber

phone

string

Phone number of the user.

country_code

integer

Country code for mobile number.

active

boolean

Is the phone number active.

primary

boolean

Is it a primary phone number.

verified

boolean

Is the phone number verified.

emails

array of object (Email)

Array of Email

string

Email address.

active

boolean

Is the email active.

primary

boolean

Is it a primary email.

verified

boolean

Is the email verified.

gender

string

dob

string

active

boolean

profile_pic_url

string

username

string

account_type

string

_id

string

created_at

string

updated_at

string

external_id

string

rr_id

string

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

user_id:

"61f02c3dcc701256044ed6c0"

body:

body

Was this section helpful?

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/{user_id}

Response

PUT

Archive User

Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account.

Parameters

company_id

string

Required

Company ID

application_id

string

Required

Application ID

Request body

user_id

string

Response

200

400

Success

ArchiveUserSuccess

success

boolean

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

body:

body

Was this section helpful?

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/archive

Response

Customer Attributes

Customer attributes enable the tagging of custom values against any customer. This allows the tagging of customer behavior with unique values, which can later be used to categorize customers into specific groups. Before adding any values to customers, definitions for customer attributes must be present. Attributes support multiple data types for defining new attributes for customers.

Operations

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition

# Create a User Attribute Definition

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition

# Get User Attribute Definitions

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}

# Update User Attribute Definition

DEL

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}

# Delete User Attribute Definition

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}

# Get User Attribute Definition

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}

# Update Or Create User Attribute

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}

# Get User Attribute

DEL

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}

# Delete User Attribute

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/user/{user_id}

# Get All Customer Attributes

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/attribute/{attribute_id}

# Get User Attribute

POST

Create a User Attribute Definition

Create a new User Attribute Definition

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

Request body

name

string

slug

string

description

string

type

string

multi_value

boolean

customer_editable

boolean

encrypted

boolean

pinned

boolean

pin_order

number

default_value

string

validations

array of object

Response

200

400

Success. returns created User Attribute Definition. `UserAttributeDefinitionResponse` for more details.

UserAttributeDefinitionResponse

_id

string

The unique identifier for the attribute definition.

name

string

The attribute name.

slug

string

The attribute key.

description

string

The description of the attribute.

application_id

string

The application ID.

type

string

The attribute type.

Enum

multi_value

boolean

Whether the attribute supports multiple values.

customer_editable

boolean

Whether the attribute is customer-editable.

encrypted

boolean

Whether the attribute is encrypted.

pinned

boolean

Whether the attribute is pinned.

pin_order

integer

The order in which the attribute is pinned.

validations

array of object (UserAttributeDefinitionValidation)

Array of UserAttributeDefinitionValidation

type

string

The type of validation.

Enum

value

Undefined Type

The validation value.

is_locked

boolean

Whether the attribute is locked.

created_by

string

The user who created the attribute.

updated_by

string

The user who last updated the attribute.

created_at

string

| date-time

The creation date of the attribute definition.

modified_at

string

| date-time

The last modification date of the attribute definition.

Examples

Parameters

company_id:

"value"

application_id:

"value"

body:

body

Was this section helpful?

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition

Response

GET

Get User Attribute Definitions

Retrieve user attribute definitions.

Parameters

excluding_ids

string

Exclude attribute definitions by Ids

slug

string

Filter by attribute slug.

type

string

Filter by attribute type.

customer_editable

boolean

Filter by customer_editable status.

encrypted

boolean

Filter by encrypted status.

pinned

boolean

Filter by pinned status.

pin_order

integer

Filter by pin order.

is_locked

boolean

Filter by locked status.

name

string

Filter by attribute name using a case-insensitive regex.

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

page_size

integer

The number of items to retrieve in each page. Default value is 10.

Default Value : 10

page_no

integer

The page number to navigate through the given set of results. Default value is 1.

Default Value : 1

Response

200

400

Successful response

Properties

items

array of object (UserAttributeDefinition)

Array of UserAttributeDefinition

_id

string

The unique identifier for the attribute definition.

name

string

The attribute name.

slug

string

The attribute key.

description

string

The description of the attribute.

application_id

string

The application ID.

type

string

The attribute type.

Enum

multi_value

boolean

Whether the attribute supports multiple values.

customer_editable

boolean

Whether the attribute is customer-editable.

encrypted

boolean

Whether the attribute is encrypted.

pinned

boolean

Whether the attribute is pinned.

pin_order

integer

The order in which the attribute is pinned.

validations

array of object

is_locked

boolean

Whether the attribute is locked.

created_at

string

The creation date of the attribute.

modified_at

string

The modification date of the attribute.

__v

integer

The version number of the attribute.

page

object

Properties

type

string

current

integer

size

integer

item_total

integer

has_next

boolean

Examples

Parameters

excluding_ids:

"value"

slug:

"value"

type:

"value"

customer_editable:

false

encrypted:

false

pinned:

false

pin_order:

is_locked:

false

name:

"value"

company_id:

"value"

application_id:

"value"

page_size:

page_no:

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition

Response

PUT

Update User Attribute Definition

Update an existing user attribute definition.

Parameters

attribute_def_id

string

Required

The unique identifier of the attribute definition to update.

application_id

string

Required

Application ID.

company_id

string

Required

Company ID.

Request body

name

string

slug

string

description

string

type

string

multi_value

boolean

customer_editable

boolean

encrypted

boolean

pinned

boolean

pin_order

number

default_value

string

validations

array of object

Response

200

400

Successful update

UserAttributeDefinition

_id

string

The unique identifier for the attribute definition.

name

string

The attribute name.

slug

string

The attribute key.

description

string

The description of the attribute.

application_id

string

The application ID.

type

string

The attribute type.

Enum

multi_value

boolean

Whether the attribute supports multiple values.

customer_editable

boolean

Whether the attribute is customer-editable.

encrypted

boolean

Whether the attribute is encrypted.

pinned

boolean

Whether the attribute is pinned.

pin_order

integer

The order in which the attribute is pinned.

validations

array of object

is_locked

boolean

Whether the attribute is locked.

created_at

string

The creation date of the attribute.

modified_at

string

The modification date of the attribute.

__v

integer

The version number of the attribute.

Examples

Parameters

attribute_def_id:

"value"

application_id:

"value"

company_id:

"value"

body:

body

Was this section helpful?

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}

Response

DEL

Delete User Attribute Definition

Delete a user attribute definition by its unique identifier.

Parameters

attribute_def_id

string

Required

The unique identifier of the attribute definition to delete.

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

Response

200

400

Successful Deletion

SuccessMessageResponse

success

string

Examples

Parameters

attribute_def_id:

"value"

company_id:

"value"

application_id:

"value"

Was this section helpful?

DEL

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}

Response

GET

Get User Attribute Definition

Get a user attribute definition by its unique identifier.

Parameters

attribute_def_id

string

Required

The unique identifier of the attribute definition to retrieve.

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

Response

200

Successful Retrieval

UserAttributeDefinition

_id

string

The unique identifier for the attribute definition.

name

string

The attribute name.

slug

string

The attribute key.

description

string

The description of the attribute.

application_id

string

The application ID.

type

string

The attribute type.

Enum

multi_value

boolean

Whether the attribute supports multiple values.

customer_editable

boolean

Whether the attribute is customer-editable.

encrypted

boolean

Whether the attribute is encrypted.

pinned

boolean

Whether the attribute is pinned.

pin_order

integer

The order in which the attribute is pinned.

validations

array of object

is_locked

boolean

Whether the attribute is locked.

created_at

string

The creation date of the attribute.

modified_at

string

The modification date of the attribute.

__v

integer

The version number of the attribute.

Examples

Parameters

attribute_def_id:

"value"

company_id:

"value"

application_id:

"value"

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}

Response

PUT

Update Or Create User Attribute

Parameters

attribute_def_id

string

Required

The unique identifier of the attribute definition to update.

user_id

string

Required

The unique identifier of the user to update.

application_id

string

Required

Application ID.

company_id

string

Required

Company ID.

Request body

customer_overriden

boolean

attribute

object

Response

200

400

Successful update

UserAttributeResponse

_id

string

The unique identifier for the attribute definition.

name

string

The name of user attribute definition.

user_id

string

The unique identifier for the user.

application_id

string

The application ID.

type

string

The attribute type.

Enum

customer_overriden

boolean

Whether the attribute is customer-editable.

attribute

object

updated_by

string

Examples

Parameters

attribute_def_id:

"value"

user_id:

"value"

application_id:

"value"

company_id:

"value"

body:

body

Was this section helpful?

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}

Response

GET

Get User Attribute

Parameters

attribute_def_id

string

Required

The unique identifier of the attribute definition.

user_id

string

Required

The unique identifier of the user.

application_id

string

Required

Application ID.

company_id

string

Required

Company ID.

Response

200

400

Successful update

UserAttributeResponse

_id

string

The unique identifier for the attribute definition.

name

string

The name of user attribute definition.

user_id

string

The unique identifier for the user.

application_id

string

The application ID.

type

string

The attribute type.

Enum

customer_overriden

boolean

Whether the attribute is customer-editable.

attribute

object

updated_by

string

Examples

Parameters

attribute_def_id:

"value"

user_id:

"value"

application_id:

"value"

company_id:

"value"

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}

Response

DEL

Delete User Attribute

Parameters

attribute_def_id

string

Required

The unique identifier of the attribute definition.

user_id

string

Required

The unique identifier of the user.

application_id

string

Required

Application ID.

company_id

string

Required

Company ID.

Response

200

400

Successful update

SuccessMessageResponse

success

string

Examples

Parameters

attribute_def_id:

"value"

user_id:

"value"

application_id:

"value"

company_id:

"value"

Was this section helpful?

DEL

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}

Response

GET

Get All Customer Attributes

Retrieve all user attributes for a specific user

Parameters

user_id

string

Required

The unique identifier of the user to update.

application_id

string

Required

Application ID.

company_id

string

Required

Company ID.

page_size

integer

The number of items to retrieve in each page. Default value is 10.

Default Value : 10

page_no

integer

The page number to navigate through the given set of results. Default value is 1.

Default Value : 1

Response

200

400

Successful update

Properties

items

array of object (UserAttributeResponse)

Array of UserAttributeResponse

_id

string

The unique identifier for the attribute definition.

name

string

The name of user attribute definition.

user_id

string

The unique identifier for the user.

application_id

string

The application ID.

type

string

The attribute type.

Enum

customer_overriden

boolean

Whether the attribute is customer-editable.

attribute

object

updated_by

string

page

object

Properties

type

string

current

integer

size

integer

item_total

integer

has_next

boolean

Examples

Parameters

user_id:

"value"

application_id:

"value"

company_id:

"value"

page_size:

page_no:

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/user/{user_id}

Response

GET

Get User Attribute

Retrieve User Attribute details by ID.

Parameters

attribute_id

string

Required

The unique identifier of the attribute to get.

application_id

string

Required

Application ID.

company_id

string

Required

Company ID.

Response

200

400

Successful update

UserAttributeResponse

_id

string

The unique identifier for the attribute definition.

name

string

The name of user attribute definition.

user_id

string

The unique identifier for the user.

application_id

string

The application ID.

type

string

The attribute type.

Enum

customer_overriden

boolean

Whether the attribute is customer-editable.

attribute

object

updated_by

string

Examples

Parameters

attribute_id:

"value"

application_id:

"value"

company_id:

"value"

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/attribute/{attribute_id}

Response

Customer Group

Customer groups allow the creation of targeted audience segments based on specific attributes or manual inclusion via phone or email. These groups enable the restriction of coupon and promotion usage, as well as the targeting of discounts, to users within the defined groups.

Operations

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group

# Create User Group

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group

# Get User Groups

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}

# Update User Group

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}

# Get User Group

PATCH

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}

# Modify User Group

POST

Create User Group

Form and add a new user group.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

Request body

conditions

array of object (ConditionsSchema)

Array of ConditionsSchema

user_attribute_definition_id

string

type

string

value

string

type

string

name

string

Required

description

string

Required

file_url

string

Response

201

Success. returns created User Group. `UserGroupResponseSchema` for more details.

UserGroupResponseSchema

conditions

array of object (Conditions)

Array of Conditions

user_attribute_definition_id

string

type

string

value

string

key

string

error

object (UserResponseErrorSchema)

UserResponseErrorSchema

count

integer

file_url

string

name

string

description

string

file_url

string

_id

string

status

string

is_active

boolean

type

string

uid

integer

application_id

string

created_at

string

modified_at

string

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

body:

body

Was this section helpful?

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group

Response

GET

Get User Groups

Retrieve a list of user groups.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

page_no

string

page number for pagination result

page_size

string

page size for pagination result

name

string

to search for User Groups which contains given string in their name

type

string

to search for User Groups with given type

Enum

status

string

to get User Groups with given status

group_uid

integer

to get User Groups with given uid

Response

200

Success. User Group details. `UserGroupListResponseSchema` for more details.

UserGroupListResponseSchema

items

array of object (UserGroupResponseSchema)

Array of UserGroupResponseSchema

conditions

array of object (Conditions)

Array of Conditions

user_attribute_definition_id

string

type

string

value

string

key

string

error

object (UserResponseErrorSchema)

UserResponseErrorSchema

count

integer

file_url

string

name

string

description

string

file_url

string

_id

string

status

string

is_active

boolean

type

string

uid

integer

application_id

string

created_at

string

modified_at

string

__v

integer

page

object (PaginationSchema)

PaginationSchema

size

integer

item_total

integer

has_next

boolean

type

string

current

integer

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

page_no:

"1"

page_size:

"10"

type:

"test"

status:

"test"

group_uid:

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group

Response

PUT

Update User Group

Modify and update user group details.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

group_id

string

Required

Numeric ID allotted to a User Group

Request body

conditions

array of object (ConditionsSchema)

Array of ConditionsSchema

user_attribute_definition_id

string

type

string

value

string

type

string

name

string

description

string

file_url

string

Response

200

404

Success. returns updated User Group. `UserGroupResponseSchema` for more details.

UserGroupResponseSchema

conditions

array of object (Conditions)

Array of Conditions

user_attribute_definition_id

string

type

string

value

string

key

string

error

object (UserResponseErrorSchema)

UserResponseErrorSchema

count

integer

file_url

string

name

string

description

string

file_url

string

_id

string

status

string

is_active

boolean

type

string

uid

integer

application_id

string

created_at

string

modified_at

string

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000004"

group_id:

"6345677535474fbb6944b7ce"

body:

body

Was this section helpful?

PUT

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}

Response

GET

Get User Group

Retrieve a user group by its unique identifier.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

group_id

string

Required

Numeric ID allotted to a User Group

Response

200

404

Success. User Group details. `UserGroupResponseSchema` for more details.

UserGroupResponseSchema

conditions

array of object (Conditions)

Array of Conditions

user_attribute_definition_id

string

type

string

value

string

key

string

error

object (UserResponseErrorSchema)

UserResponseErrorSchema

count

integer

file_url

string

name

string

description

string

file_url

string

_id

string

status

string

is_active

boolean

type

string

uid

integer

application_id

string

created_at

string

modified_at

string

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000004"

group_id:

"6345677535474fbb6944b7ce"

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}

Response

PATCH

Modify User Group

Update user group partially on the platform.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

group_id

string

Required

Numeric ID allotted to a User Group

Request body

type

string

Source of update to be used to update individual users. Default value is considered file_url if not passed.

Enum

name

string

description

string

file_url

string

Required property when passed type file_url. Internet reachable csv file url which will be used to fetch download data. It must have one of columns from `phone_number``, `email``, `user_id`` and must have `action` column. `action` column can have `add` or `remove` value.

user_data

array of object (UserGroupUpdateData)

Required property when passed type json. Array of user data. Must have `action` field and one of `phone_number`, `email` or `user_id` field in object

Array of UserGroupUpdateData

user_id

string

Must be valid mongodb objectid of existing user

phone_number

string

Phone number of registered user

string

Email of registered user

action

string

Required

Enum

Response

200

404

Success. returns updated User Group. `UserGroupResponseSchema` for more details.

UserGroupResponseSchema

conditions

array of object (Conditions)

Array of Conditions

user_attribute_definition_id

string

type

string

value

string

key

string

error

object (UserResponseErrorSchema)

UserResponseErrorSchema

count

integer

file_url

string

name

string

description

string

file_url

string

_id

string

status

string

is_active

boolean

type

string

uid

integer

application_id

string

created_at

string

modified_at

string

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000004"

group_id:

"6345677535474fbb6944b7ce"

body:

body

Was this section helpful?

PATCH

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}

Response

Customer Session

Handles unique sessions representing a logged-in customer, including creating new sessions with configurable expiration times and can activate session rolling which extends session duration until expiration from, platform, terminating specific sessions, retrieving information about active sessions, and clearing active sessions as required which will logout the customer.

Operations

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session

# Create User Session

DEL

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session

# Delete User Session

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions

# Get User Active Sessions

DEL

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions

# Delete User Active Sessions

POST

Create User Session

Create session for user interactions

Parameters

company_id

string

Required

Company ID

application_id

string

Required

Application ID

Request body

domain

string

user_id

string

Response

200

400

Create user session

CreateUserSessionResponseSchema

domain

string

max_age

number

secure

boolean

http_only

boolean

object

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

body:

body

Was this section helpful?

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session

Response

DEL

Delete User Session

Terminate an active user session.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

string

Required

ID of a customer.

session_id

string

Required

Session ID of a customer.

reason

string

Required

Reason for deleting session.

Response

200

400

Success. Refer `SessionDeleteResponseSchema` for more details.

SessionDeleteResponseSchema

user_id

string

session_id

string

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

id:

"61f02c3dcc701256044ed6c0"

session_id:

"000000000000000000000001"

reason:

"test"

Was this section helpful?

DEL

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session

Response

Example not available.

GET

Get User Active Sessions

Retrieve a list of currently active user sessions.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

string

Required

ID of a customer.

Response

200

400

Success. Refer `SessionListResponseSchema` for more details.

SessionListResponseSchema

items

array of object (SessionListResponseInfo)

Array of SessionListResponseInfo

session_id

string

user_agent

string

domain

string

expire_in

string

location

string

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

id:

"61f02c3dcc701256044ed6c0"

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions

Response

Example not available.

DEL

Delete User Active Sessions

Terminate all active user sessions.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

string

Required

ID of a customer.

reason

string

Required

Reason to delete sessions.

Response

200

400

Success. Refer `SessionsDeleteResponseSchema` for more details.

SessionsDeleteResponseSchema

user_id

string

session_ids

array of string

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

id:

"61f02c3dcc701256044ed6c0"

reason:

"test"

Was this section helpful?

DEL

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions

Response

Example not available.

Website Authentication

Manage authentication configurations for platform-wide sales channels, offering flexibility to mandate either email, mobile, or both for registration/login. Configure whether a password is necessary, along with specifying password requirements and history restrictions. Implement account lockout after a defined number of failed login attempts for enhanced security.

Operations

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/platform/config

# Get Platform Config

POST

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/platform/config

# Update Platform Config

GET

Get Platform Config

Retrieve platform sales channel authentication configuration.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

Response

200

Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.

PlatformSchema

display

string

look_and_feel

object (LookAndFeel)

LookAndFeel

card_position

string

background_color

string

updated_at

string

active

boolean

forgot_password

boolean

object (Login)

password

boolean

otp

boolean

skip_captcha

boolean

name

string

meta

object (MetaSchema)

MetaSchema

fynd_default

boolean

_id

string

social

object (Social)

Social

account_kit

boolean

facebook

boolean

google

boolean

apple

boolean

required_fields

object (RequiredFields)

RequiredFields

object (PlatformEmail)

PlatformEmail

is_required

boolean

level

string

mobile

object (PlatformMobile)

PlatformMobile

is_required

boolean

level

string

register_required_fields

object (RegisterRequiredFields)

RegisterRequiredFields

object (RegisterRequiredFieldsEmail)

RegisterRequiredFieldsEmail

is_required

boolean

level

string

mobile

object (RegisterRequiredFieldsMobile)

RegisterRequiredFieldsMobile

is_required

boolean

level

string

skip_login

boolean

flash_card

object (FlashCard)

FlashCard

text

string

text_color

string

background_color

string

subtext

string

social_tokens

object (SocialTokens)

SocialTokens

facebook

object (Facebook)

Facebook

app_id

string

app_secret

string

account_kit

object (Accountkit)

Accountkit

app_id

string

app_secret

string

google

object (Google)

Google

app_id

string

app_secret

string

created_at

string

boolean

mobile_image

string

desktop_image

string

delete_account_day

integer

delete_account_reasons

array of object (DeleteAccountReasons)

Array of DeleteAccountReasons

reason_text

string

reason_id

string

show_text_area

boolean

delete_account_consent

object (DeleteAccountConsent)

DeleteAccountConsent

consent_text

string

session_config

object (SessionExpiry)

SessionExpiry

duration

integer

type

string

Enum

is_rolling

boolean

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"000000000000000000000001"

Was this section helpful?

GET

/service/platform/user/v1.0/company/{company_id}/application/{application_id}/platform/config

Response

POST

Update Platform Config

Modify and update platform sales channel authentication configuration.

Parameters

company_id

string

Required

Numeric ID allotted to a business account on Fynd Platform.

application_id

string

Required

Alphanumeric ID allotted to an application created within a business account.

Request body

display

string

look_and_feel

object (LookAndFeel)

LookAndFeel

card_position

string

background_color

string

updated_at

string

active

boolean

forgot_password

boolean

object (Login)

password

boolean

otp

boolean

skip_captcha

boolean

name

string

User

Customer

Get a List of Users

Get a List of Users

getCustomers

Search an Existing Users

Search an Existing Users

searchUsers

Create User

Create User

createUser

Block/Unblock Users

Block/Unblock Users

blockOrUnblockUsers

Restore Deleted User

Restore Deleted User

unDeleteUser

Update User Details

Update User Details

updateUser

Archive User

Archive User

archiveUser

Customer Attributes

Create a User Attribute Definition

Create a User Attribute Definition

createUserAttributeDefinition

Get User Attribute Definitions

Get User Attribute Definitions

getUserAttributeDefinitions

Update User Attribute Definition

Update User Attribute Definition

updateUserAttributeDefinition

Delete User Attribute Definition

Delete User Attribute Definition

deleteUserAttributeDefinitionById

Get User Attribute Definition

Get User Attribute Definition

getUserAttributeDefinitionById

Update Or Create User Attribute

Update Or Create User Attribute

updateUserAttribute

Get User Attribute

Get User Attribute

getUserAttribute

Delete User Attribute

Delete User Attribute

deleteUserAttribute

Get All Customer Attributes

Get All Customer Attributes

getUserAttributesForUser

Get User Attribute

Get User Attribute

getUserAttributeById

Customer Group

Create User Group

Create User Group

createUserGroup

Get User Groups

Get User Groups

getUserGroups

Update User Group

Update User Group

updateUserGroup

Get User Group

Get User Group

getUserGroupById

Modify User Group

Modify User Group

updateUserGroupPartially

Customer Session

Create User Session

Create User Session

createUserSession

Delete User Session

Delete User Session

deleteSession

Get User Active Sessions

Get User Active Sessions

getActiveSessions