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.
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
# Get a List of Users
GET
# Search an Existing Users
POST
# Create User
PUT
# Block/Unblock Users
PUT
# Restore Deleted User
PUT
# Update User Details
PUT
# Archive User
GET
# Get users belonging to user group by Id
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.
q
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
__v
number
version indicator.
has_old_password_hash
boolean
indicates if record contains old password hash.
debug
object (DebugInfo)
DebugInfo
source
string
Source service name.
platform
string
Platform type(eg; platform, partner).
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
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
Nullable
dob
string
active
boolean
profile_pic_url
string
username
string
account_type
string
_id
string
created_at
string
| date-time
updated_at
string
| date-time
external_id
string
rr_id
string
archive
boolean
status
string
page
object (PaginationSchema)
PaginationSchema
size
integer
item_total
integer
has_next
boolean
type
string
current
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
q:
"{"$or":[{"emails.email":"vinit.mav12@gofynd.com"},{"phoneNumbers.phone":"vinit.mav12@gofynd.com"}]}"
page_size:
1
page_no:
1
Was this section helpful?
GET
Response
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.
q
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
__v
number
version indicator.
has_old_password_hash
boolean
indicates if record contains old password hash.
debug
object (DebugInfo)
DebugInfo
source
string
Source service name.
platform
string
Platform type(eg; platform, partner).
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
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
Nullable
dob
string
active
boolean
profile_pic_url
string
username
string
account_type
string
_id
string
created_at
string
| date-time
updated_at
string
| date-time
external_id
string
rr_id
string
archive
boolean
status
string
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
q:
"vinit.mav12@gofynd.com"
query:
"vinit.mav12@gofynd.com"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Company ID
application_id
string
Required
Application ID
Request body
phone_number
string
Required
email
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
password_last_modified
string
password_history
array of object (UserPasswordHistory)
Array of UserPasswordHistory
salt
string
hash
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
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
Nullable
dob
string
active
boolean
profile_pic_url
string
username
string
account_type
string
_id
string
created_at
string
| date-time
updated_at
string
| date-time
external_id
string
rr_id
string
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
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
Required
user_id
array of string
Required
reason
string
Required
Response
200
400
Success
BlockUserSuccess
success
boolean
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Company ID
application_id
string
Required
Application ID
Request body
user_id
string
Required
reason
string
Required
reason_id
string
Required
Response
200
400
Success
UnDeleteUserSuccess
success
boolean
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
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
email
string
Response
200
400
User update
CreateUserResponseSchema
user
object (UserSchema)
UserSchema
application_id
string
user_id
string
password_last_modified
string
password_history
array of object (UserPasswordHistory)
Array of UserPasswordHistory
salt
string
hash
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
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
Nullable
dob
string
active
boolean
profile_pic_url
string
username
string
account_type
string
_id
string
created_at
string
| date-time
updated_at
string
| date-time
external_id
string
rr_id
string
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
user_id:
"61f02c3dcc701256044ed6c0"
body:
body
Was this section helpful?
PUT
Response
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
Required
Response
200
404
Success
ArchiveUserSuccess
success
boolean
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
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. Users in User Group. `CustomerListResponseSchema` for more details.
CustomerListResponseSchema
items
array of object (UserSearchSchema)
Array of UserSearchSchema
__v
number
version indicator.
has_old_password_hash
boolean
indicates if record contains old password hash.
debug
object (DebugInfo)
DebugInfo
source
string
Source service name.
platform
string
Platform type(eg; platform, partner).
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
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
Nullable
dob
string
active
boolean
profile_pic_url
string
username
string
account_type
string
_id
string
created_at
string
| date-time
updated_at
string
| date-time
external_id
string
rr_id
string
archive
boolean
status
string
page
object (PaginationSchema)
PaginationSchema
size
integer
item_total
integer
has_next
boolean
type
string
current
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
group_id:
"6345677535474fbb6944b7ce"
Was this section helpful?
GET
Response
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
# Create a User Attribute Definition
GET
# Get User Attribute Definitions
PUT
# Update User Attribute Definition
DEL
# Delete User Attribute Definition
GET
# Get User Attribute Definition
PUT
# Update Or Create User Attribute
GET
# Get User Attribute
DEL
# Delete User Attribute
GET
# Get All Customer Attributes
GET
# Get User Attribute
PUT
# Bulk Update User Attributes
PUT
# Bulk Update Different Attributes Per User
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
The name of user attribute definition.
slug
string
The unique identifier of user attribute definition.
description
string
The description for the user attribute definition.
type
string
The attribute type for the user attribute definition.
multi_value
boolean
Identifier to specify if attribute will have multiple values or not.
customer_editable
boolean
Identifier to specify if attribute can be edited by the customer.
encrypted
boolean
Identifier to specify if attribute will be stored in encrypted format.
pinned
boolean
Identifier to specify if the definition is pinned or not.
pin_order
number
Pin order of the Attribute Definition.
default_value
object
The default value for the User Attribute Definition. Data type of the default value depends on the type of the attribute definition type defined.
validations
array of object
The custom validations that have been set for this customer definition.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
201
400
Success. returns created User Attribute Definition. `UserAttributeDefinitionResponse` for more details.
UserAttributeDefinitionResp
_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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Parameters
excluding_ids
string
Exclude attribute definitions by Ids
slug
string
Filter by attribute slug.
type
string
Filter by attribute type.
Enum
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
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
| date-time
The creation date of the attribute.
modified_at
string
| date-time
The modification date of the attribute.
__v
integer
The version number of the attribute.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object
Properties
type
string
current
integer
size
integer
item_total
integer
has_next
boolean
Examples
Parameters
excluding_ids:
"6345677535474fbb6944b7ce"
slug:
"test"
type:
"number"
customer_editable:
true
encrypted:
true
pinned:
true
pin_order:
1
is_locked:
true
name:
"test"
company_id:
"559"
application_id:
"000000000000000000000001"
page_size:
10
page_no:
1
Was this section helpful?
GET
Response
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
The name of user attribute definition.
slug
string
The unique identifier of user attribute definition.
description
string
The description for the user attribute definition.
type
string
The attribute type for the user attribute definition.
multi_value
boolean
Identifier to specify if attribute will have multiple values or not.
customer_editable
boolean
Identifier to specify if attribute can be edited by the customer.
encrypted
boolean
Identifier to specify if attribute will be stored in encrypted format.
pinned
boolean
Identifier to specify if the definition is pinned or not.
pin_order
number
Pin order of the Attribute Definition.
default_value
object
The default value for the User Attribute Definition. Data type of the default value depends on the type of the attribute definition type defined.
validations
array of object
The custom validations that have been set for this customer definition.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
404
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
| date-time
The creation date of the attribute.
modified_at
string
| date-time
The modification date of the attribute.
__v
integer
The version number of the attribute.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
attribute_def_id:
"6345677535474fbb6944b7ae"
application_id:
"000000000000000000000001"
company_id:
"559"
body:
body
Was this section helpful?
PUT
Response
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
404
Successful Deletion
SuccessMessage
success
string
Examples
Parameters
attribute_def_id:
"6345677535474fbb6944b7ae"
company_id:
"559"
application_id:
"000000000000000000000001"
Was this section helpful?
DEL
Response
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
404
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
| date-time
The creation date of the attribute.
modified_at
string
| date-time
The modification date of the attribute.
__v
integer
The version number of the attribute.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
attribute_def_id:
"6345677535474fbb6944b7ae"
company_id:
"559"
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
201
400
Successful update
UserAttribute
_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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
attribute_def_id:
"6345677535474fbb6944b81e"
user_id:
"61f02c3dcc701256044ed6c0"
application_id:
"000000000000000000000001"
company_id:
"559"
body:
body
Was this section helpful?
PUT
Response
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
404
Successful update
UserAttribute
_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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
attribute_def_id:
"6345677535474fbb6944b71e"
user_id:
"61f02c3dcc701256044ed6c0"
application_id:
"000000000000000000000001"
company_id:
"559"
Was this section helpful?
GET
Response
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
404
Successful update
SuccessMessage
success
string
Examples
Parameters
attribute_def_id:
"6345677535474fbb6944b72e"
user_id:
"61f02c3dcc701256044ed6c0"
application_id:
"000000000000000000000001"
company_id:
"559"
Was this section helpful?
DEL
Response
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
Successful update
Properties
items
array of object (UserAttribute)
Array of UserAttribute
_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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object
Properties
type
string
current
integer
size
integer
item_total
integer
has_next
boolean
Examples
Parameters
user_id:
"61f02c3dcc701256044ed6c0"
application_id:
"000000000000000000000001"
company_id:
"559"
page_size:
10
page_no:
1
Was this section helpful?
GET
Response
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
404
Successful update
UserAttribute
_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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
attribute_id:
"6345677535474fbb6944b1ae"
application_id:
"000000000000000000000001"
company_id:
"559"
Was this section helpful?
GET
Response
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
users
array of string
Array of user IDs to update (required unless user_file_url is provided)
user_file_url
string
| uri
URL to a CSV file containing user IDs (required unless users array is provided)
attribute
array of object (BulkUpdateUserSameAttributes)
Array of attribute key-value pairs to update for all users
Array of BulkUpdateUserSameAttributes
key
string
Required
Slug of the attribute definition
value
Undefined Type
Required
Value to set for all users (type depends on the attribute type)
Response
200
400
Synchronous processing completed successfully
BulkOperation
success
boolean
Whether the operation was successful
total
integer
Total number of users to process
processed
integer
Number of users successfully processed
errors_count
integer
Number of errors encountered
errors
array of object (BulkOperationError)
Array of errors encountered during processing
Array of BulkOperationError
user_id
string
ID of the user for which the error occurred
error
string
Error message
processing_type
string
Type of processing used (synchronous or asynchronous)
Enum
error_summary
object
Contains key indicating reason of error
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update different sets of attributes for different users in a single request
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
user_detail_attributes
array of object (UserDetailAttributes)
Required
Object with user IDs and attribute arrays
Array of UserDetailAttributes
user_id
string
Unique identifier of user.
attributes
array of object (BulkUpdatePerUserAttributes)
Array of attribute key-value pairs to update for this user
Array of BulkUpdatePerUserAttributes
key
string
Required
Slug of the attribute definition
value
object
Required
Value to set (type depends on the attribute type)
Response
200
400
Operation completed successfully
BulkOperation
success
boolean
Whether the operation was successful
total
integer
Total number of users to process
processed
integer
Number of users successfully processed
errors_count
integer
Number of errors encountered
errors
array of object (BulkOperationError)
Array of errors encountered during processing
Array of BulkOperationError
user_id
string
ID of the user for which the error occurred
error
string
Error message
processing_type
string
Type of processing used (synchronous or asynchronous)
Enum
error_summary
object
Contains key indicating reason of error
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
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
# Create User Group
GET
# Get User Groups
PUT
# Update User Group
GET
# Get User Group
PATCH
# Modify 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
object
type
string
name
string
Required
description
string
Required
file_url
string
blacklisted_users
array of 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
object
key
string
blacklisted_users
array of 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
tags
array of string
created_at
string
| date-time
modified_at
string
| date-time
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
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
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
object
key
string
blacklisted_users
array of 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
tags
array of string
created_at
string
| date-time
modified_at
string
| date-time
__v
integer
page
object (PaginationSchema)
PaginationSchema
size
integer
item_total
integer
has_next
boolean
type
string
current
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
page_no:
"1"
page_size:
"10"
group_uid:
30
Was this section helpful?
GET
Response
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
object
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
object
key
string
blacklisted_users
array of 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
tags
array of string
created_at
string
| date-time
modified_at
string
| date-time
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
group_id:
"6345677535474fbb6944b7ce"
body:
body
Was this section helpful?
PUT
Response
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
object
key
string
blacklisted_users
array of 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
tags
array of string
created_at
string
| date-time
modified_at
string
| date-time
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
group_id:
"6345677535474fbb6944b7ce"
Was this section helpful?
GET
Response
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
email
string
Email of registered user
action
string
Required
Enum
whitelisted_users
array of string
List of user ids to be whitelisted from user group
blacklisted_users
array of string
List of user ids to be blacklisted from user group
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
object
key
string
blacklisted_users
array of 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
tags
array of string
created_at
string
| date-time
modified_at
string
| date-time
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
group_id:
"6345677535474fbb6944b7ce"
body:
body
Was this section helpful?
PATCH
Response
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
# Create User Session
DEL
# Delete User Session
GET
# Get User Active Sessions
DEL
# Delete User Active Sessions
Parameters
company_id
string
Required
Company ID
application_id
string
Required
Application ID
Request body
domain
string
Required
user_id
string
Required
max_age
number
Response
200
400
Create user session
CreateUserSessionResponseSchema
domain
string
max_age
number
secure
boolean
http_only
boolean
cookie
object
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
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.
id
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
Response
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.
id
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
ip
string
domain
string
expire_in
string
location
string
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
id:
"61f02c3dcc701256044ed6c0"
Was this section helpful?
GET
Response
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.
id
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
Response
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
# Get Platform Config
POST
# Update Platform Config
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
| date-time
active
boolean
forgot_password
boolean
login
object (Login)
Login
password
boolean
otp
boolean
via
string
Enum
account_lockout
object (AccountLockout)
AccountLockout
enable
boolean
attempts
number
duration
number
password_settings
object (PasswordSettings)
PasswordSettings
configs
object (PasswordConfigs)
PasswordConfigs
length
number
require_special_character
boolean
require_number
boolean
require_capital_character
boolean
history
object (PasswordHistory)
PasswordHistory
required
boolean
count
number
expiry
object (PasswordExpiry)
PasswordExpiry
required
boolean
duration
number
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
email
object (PlatformEmail)
PlatformEmail
is_required
boolean
level
string
mobile
object (PlatformMobile)
PlatformMobile
is_required
boolean
level
string
password
object (PlatformPassword)
PlatformPassword
is_required
boolean
register_required_fields
object (RegisterRequiredFields)
RegisterRequiredFields
email
object (RegisterRequiredFieldsEmail)
RegisterRequiredFieldsEmail
is_required
boolean
level
string
mobile
object (RegisterRequiredFieldsMobile)
RegisterRequiredFieldsMobile
is_required
boolean
level
string
password
object (PlatformPassword)
PlatformPassword
is_required
boolean
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
accountkit
object (Accountkit)
Accountkit
app_id
string
app_secret
string
google
object (Google)
Google
app_id
string
app_secret
string
created_at
string
| date-time
register
boolean
mobile_image
string
Nullable
desktop_image
string
Nullable
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
Response
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
| date-time
active
boolean
forgot_password
boolean
login
object (Login)
Login
password
boolean
otp
boolean
via
string
Enum
account_lockout
object (AccountLockout)
AccountLockout
enable
boolean
attempts
number
duration
number
password_settings
object (PasswordSettings)
PasswordSettings
configs
object (PasswordConfigs)
PasswordConfigs
length
number
require_special_character
boolean
require_number
boolean
require_capital_character
boolean
history
object (PasswordHistory)
PasswordHistory
required
boolean
count
number
expiry
object (PasswordExpiry)
PasswordExpiry
required
boolean
duration
number
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
email
object (PlatformEmail)
PlatformEmail
is_required
boolean
level
string
mobile
object (PlatformMobile)
PlatformMobile
is_required
boolean
level
string
password
object (PlatformPassword)
PlatformPassword
is_required
boolean
register_required_fields
object (RegisterRequiredFields)
RegisterRequiredFields
email
object (RegisterRequiredFieldsEmail)
RegisterRequiredFieldsEmail
is_required
boolean
level
string
mobile
object (RegisterRequiredFieldsMobile)
RegisterRequiredFieldsMobile
is_required
boolean
level
string
password
object (PlatformPassword)
PlatformPassword
is_required
boolean
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
accountkit
object (Accountkit)
Accountkit
app_id
string
app_secret
string
google
object (Google)
Google
app_id
string
app_secret
string
created_at
string
| date-time
register
boolean
mobile_image
string
Nullable
desktop_image
string
Nullable
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
Response
200
Success. Returns a JSON object with the updated 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
| date-time
active
boolean
forgot_password
boolean
login
object (Login)
Login
password
boolean
otp
boolean
via
string
Enum
account_lockout
object (AccountLockout)
AccountLockout
enable
boolean
attempts
number
duration
number
password_settings
object (PasswordSettings)
PasswordSettings
configs
object (PasswordConfigs)
PasswordConfigs
length
number
require_special_character
boolean
require_number
boolean
require_capital_character
boolean
history
object (PasswordHistory)
PasswordHistory
required
boolean
count
number
expiry
object (PasswordExpiry)
PasswordExpiry
required
boolean
duration
number
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
email
object (PlatformEmail)
PlatformEmail
is_required
boolean
level
string
mobile
object (PlatformMobile)
PlatformMobile
is_required
boolean
level
string
password
object (PlatformPassword)
PlatformPassword
is_required
boolean
register_required_fields
object (RegisterRequiredFields)
RegisterRequiredFields
email
object (RegisterRequiredFieldsEmail)
RegisterRequiredFieldsEmail
is_required
boolean
level
string
mobile
object (RegisterRequiredFieldsMobile)
RegisterRequiredFieldsMobile
is_required
boolean
level
string
password
object (PlatformPassword)
PlatformPassword
is_required
boolean
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
accountkit
object (Accountkit)
Accountkit
app_id
string
app_secret
string
google
object (Google)
Google
app_id
string
app_secret
string
created_at
string
| date-time
register
boolean
mobile_image
string
Nullable
desktop_image
string
Nullable
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"
body:
body
Was this section helpful?
POST
Response