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
GET
# Get Deleted User Timeline
PUT
# Update User Details
PUT
# Archive User
POST
# Bulk import storefront customers using CSV and XLSX files.
GET
# Get Bulk User's Import Lists for a specific Application.
POST
# Bulk export storefront customers using CSV and XLSX files.
GET
# Get Bulk User's Export Lists for a specific Application.
GET
# Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
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
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
dob
string
active
boolean
profile_pic_url
string
username
string
account_type
string
Enum
_id
string
created_at
string
| date-time
updated_at
string
| date-time
external_id
string
rr_id
string
archive
boolean
status
string
deleted_on
string
| date-time
page
object (PaginationSchema)
PaginationSchema
size
integer
The number of items per page.
item_total
integer
The total number of items across all pages.
has_next
boolean
Indicates whether there are more pages to retrieve.
type
string
The type of pagination used (eg Number).
current
integer
The current page number.
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
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
dob
string
active
boolean
profile_pic_url
string
username
string
account_type
string
Enum
_id
string
created_at
string
| date-time
updated_at
string
| date-time
external_id
string
rr_id
string
archive
boolean
status
string
deleted_on
string
| date-time
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
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
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
Enum
_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
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
Response
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
Response
Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion.
Parameters
company_id
string
Required
Company ID
application_id
string
Required
Application ID
user_id
string
Required
User ID
Response
200
400
Success. Returns the user timeline along with the delete on date.
GetUserTimeline
delete_on
string
| date-time
Denotes the date on which the user will be deleted
timeline
array of object (UserTimeline)
List of user timeline events
Array of UserTimeline
date
string
| date-time
Denotes the date at which this event occured
title
string
Title of the timeline event
type
string
Type of the event, indicating its status
Enum
visible
boolean
Indicates whether the event should be shown on the UI
sub_title
string
Nullable
Additional information about the event
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
user_id:
"61f02c3dcc701256044ed6c0"
Was this section helpful?
GET
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
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
dob
string
active
boolean
profile_pic_url
string
username
string
account_type
string
Enum
_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
Response
200
400
Success
ArchiveUserSuccess
success
boolean
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
The API allows bulk import of storefront customers using CSV or XLSX files.
Parameters
application_id
string
Required
Application ID.
company_id
string
Required
Company ID.
Request body
absolute_url
string
| uri
Required
A valid URL linking to the file containing user data to be imported.
file_format
string
Required
The format of the file containing the user's data. Supported formats are CSV and XLSX.
Enum
relative_url
string
Required
A valid relative path to the file within the storage system. This path should not include the base URL or domain and must conform to the storage structure
Response
200
400
Successfully Bulk Import Users Creation
BulkActionModel
_id
string
The Job ID associated with an Import or Export Job
file_name
string
The name of the file
file_format
string
The format of the uploaded file (e.g., CSV, XLSX).
Enum
action_type
string
The type of bulk action being performed (e.g., import, export).
Enum
created_by
object (CreatedBySchema)
CreatedBySchema
name
string
The name of the user who initiated the operation.
user_id
string
A unique identifier for the user who initiated the operation.
count
object (BulkActionCountSchema)
BulkActionCountSchema
total
integer
The total number of items to be processed.
Default Value : 0
success
integer
The number of successfully processed items.
Default Value : 0
error
integer
The number of items that failed to process.
Default Value : 0
status
string
The current status of the bulk action.
Default Value : inprogress
Enum
links
object (BulkActionLinkSchema)
BulkActionLinkSchema
file
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
error
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
application_id
string
| objectid
The unique identifier of the associated application.
company_id
string
The unique identifier of the company associated with the bulk action.
created_at
string
| date-time
The timestamp when the bulk action was created.
updated_at
string
| date-time
The timestamp when the bulk action was last updated.
Examples
Parameters
application_id:
"1"
company_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
This API allows fetching the list of bulk user imports for a specific application and company.
It supports pagination and filtering based on various parameters.
Parameters
application_id
string
Required
Application ID.
company_id
string
Required
Company ID.
page_no
string
page number for pagination result
page_size
string
page size for pagination result
search
string
The search queries based on job name.
start_date
string
| date-time
Start date
end_date
string
| date-time
End date
status
string
Status of the Import Documents
Enum
file_format
string
Filter data based on file format eg csv or xlsx
Enum
Response
200
Successfully Bulk Import Users List
BulkActionPaginationSchema
items
array of object (BulkActionModel)
Array of Bulk Action Documents
Array of BulkActionModel
_id
string
The Job ID associated with an Import or Export Job
file_name
string
The name of the file
file_format
string
The format of the uploaded file (e.g., CSV, XLSX).
Enum
action_type
string
The type of bulk action being performed (e.g., import, export).
Enum
created_by
object (CreatedBySchema)
CreatedBySchema
name
string
The name of the user who initiated the operation.
user_id
string
A unique identifier for the user who initiated the operation.
count
object (BulkActionCountSchema)
BulkActionCountSchema
total
integer
The total number of items to be processed.
Default Value : 0
success
integer
The number of successfully processed items.
Default Value : 0
error
integer
The number of items that failed to process.
Default Value : 0
status
string
The current status of the bulk action.
Default Value : inprogress
Enum
links
object (BulkActionLinkSchema)
BulkActionLinkSchema
file
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
error
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
application_id
string
| objectid
The unique identifier of the associated application.
company_id
string
The unique identifier of the company associated with the bulk action.
created_at
string
| date-time
The timestamp when the bulk action was created.
updated_at
string
| date-time
The timestamp when the bulk action was last updated.
page
object (PaginationSchema)
PaginationSchema
size
integer
The number of items per page.
item_total
integer
The total number of items across all pages.
has_next
boolean
Indicates whether there are more pages to retrieve.
type
string
The type of pagination used (eg Number).
current
integer
The current page number.
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
"1"
page_no:
"1"
page_size:
"10"
search:
"test"
start_date:
"2025-01-08T04:45:03.951Z"
end_date:
"2025-01-08T04:45:03.951Z"
status:
"complete"
file_format:
"csv"
Was this section helpful?
GET
Response
This API allows bulk export of storefront users by requesting files in CSV or XLSX format.
Parameters
application_id
string
Required
Application ID.
company_id
string
Required
Company ID.
Request body
file_format
string
Required
The format of the file in which you want to export data. Supported formats are CSV and XLSX.
Enum
Response
200
400
Successfully Bulk Export Users Response
BulkActionModel
_id
string
The Job ID associated with an Import or Export Job
file_name
string
The name of the file
file_format
string
The format of the uploaded file (e.g., CSV, XLSX).
Enum
action_type
string
The type of bulk action being performed (e.g., import, export).
Enum
created_by
object (CreatedBySchema)
CreatedBySchema
name
string
The name of the user who initiated the operation.
user_id
string
A unique identifier for the user who initiated the operation.
count
object (BulkActionCountSchema)
BulkActionCountSchema
total
integer
The total number of items to be processed.
Default Value : 0
success
integer
The number of successfully processed items.
Default Value : 0
error
integer
The number of items that failed to process.
Default Value : 0
status
string
The current status of the bulk action.
Default Value : inprogress
Enum
links
object (BulkActionLinkSchema)
BulkActionLinkSchema
file
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
error
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
application_id
string
| objectid
The unique identifier of the associated application.
company_id
string
The unique identifier of the company associated with the bulk action.
created_at
string
| date-time
The timestamp when the bulk action was created.
updated_at
string
| date-time
The timestamp when the bulk action was last updated.
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
"1"
body:
body
Was this section helpful?
POST
Response
This API allows fetching the list of bulk user exports for a specific application and company.
It supports pagination and filtering based on various parameters.
Parameters
application_id
string
Required
Application ID.
company_id
string
Required
Company ID.
page_no
string
page number for pagination result
page_size
string
page size for pagination result
file_format
string
Filter data based on file format eg csv or xlsx
Enum
search
string
The search queries based on job name.
start_date
string
| date-time
Start date
end_date
string
| date-time
End date
status
string
Status of the Import Documents
Enum
Response
200
Successfully Bulk Import Users Creation
BulkActionPaginationSchema
items
array of object (BulkActionModel)
Array of Bulk Action Documents
Array of BulkActionModel
_id
string
The Job ID associated with an Import or Export Job
file_name
string
The name of the file
file_format
string
The format of the uploaded file (e.g., CSV, XLSX).
Enum
action_type
string
The type of bulk action being performed (e.g., import, export).
Enum
created_by
object (CreatedBySchema)
CreatedBySchema
name
string
The name of the user who initiated the operation.
user_id
string
A unique identifier for the user who initiated the operation.
count
object (BulkActionCountSchema)
BulkActionCountSchema
total
integer
The total number of items to be processed.
Default Value : 0
success
integer
The number of successfully processed items.
Default Value : 0
error
integer
The number of items that failed to process.
Default Value : 0
status
string
The current status of the bulk action.
Default Value : inprogress
Enum
links
object (BulkActionLinkSchema)
BulkActionLinkSchema
file
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
error
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
application_id
string
| objectid
The unique identifier of the associated application.
company_id
string
The unique identifier of the company associated with the bulk action.
created_at
string
| date-time
The timestamp when the bulk action was created.
updated_at
string
| date-time
The timestamp when the bulk action was last updated.
page
object (PaginationSchema)
PaginationSchema
size
integer
The number of items per page.
item_total
integer
The total number of items across all pages.
has_next
boolean
Indicates whether there are more pages to retrieve.
type
string
The type of pagination used (eg Number).
current
integer
The current page number.
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
"1"
page_no:
"1"
page_size:
"10"
file_format:
"csv"
search:
"test"
start_date:
"2025-01-08T04:45:03.951Z"
end_date:
"2025-01-08T04:45:03.951Z"
status:
"inprogress"
Was this section helpful?
GET
Response
GET
Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
This endpoint retrieves the details of a specific user's import and export related jobs associated with a given `job_id`, `application_id`, and `company_id`.
Parameters
application_id
string
Required
The unique identifier of the application. This is required to identify the application context for the job.
company_id
string
Required
The unique identifier of the company. This helps in scoping the request to the specific company.
job_id
string
Required
The unique identifier of the job. This is used to fetch the details of the specific job.
Response
200
400
Job details retrieved successfully.
BulkActionModel
_id
string
The Job ID associated with an Import or Export Job
file_name
string
The name of the file
file_format
string
The format of the uploaded file (e.g., CSV, XLSX).
Enum
action_type
string
The type of bulk action being performed (e.g., import, export).
Enum
created_by
object (CreatedBySchema)
CreatedBySchema
name
string
The name of the user who initiated the operation.
user_id
string
A unique identifier for the user who initiated the operation.
count
object (BulkActionCountSchema)
BulkActionCountSchema
total
integer
The total number of items to be processed.
Default Value : 0
success
integer
The number of successfully processed items.
Default Value : 0
error
integer
The number of items that failed to process.
Default Value : 0
status
string
The current status of the bulk action.
Default Value : inprogress
Enum
links
object (BulkActionLinkSchema)
BulkActionLinkSchema
file
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
error
object (FileLinks)
FileLinks
absolute_url
string
| uri
The full URL of the file, including the domain and protocol, allowing direct access to the file from any location.
relative_url
string
The relative path to the file within the storage system, excluding the base URL or domain. This path is specific to the storage structure.
application_id
string
| objectid
The unique identifier of the associated application.
company_id
string
The unique identifier of the company associated with the bulk action.
created_at
string
| date-time
The timestamp when the bulk action was created.
updated_at
string
| date-time
The timestamp when the bulk action was last updated.
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
"1"
job_id:
"64e86b2f08d02c45e8f8a456"
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
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. `UserAttributeDefinitionDetails` for more details.
UserAttributeDefinitionDetails
_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
Response
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
| 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.
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:
1
is_locked:
false
name:
"value"
company_id:
"value"
application_id:
"value"
page_size:
1
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
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
| 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.
Examples
Parameters
attribute_def_id:
"value"
application_id:
"value"
company_id:
"value"
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
400
Successful Deletion
SuccessMessage
success
string
Examples
Parameters
attribute_def_id:
"value"
company_id:
"value"
application_id:
"value"
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
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.
Examples
Parameters
attribute_def_id:
"value"
company_id:
"value"
application_id:
"value"
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_overridden
boolean
attribute
object
Response
200
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_overridden
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
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
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_overridden
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
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
400
Successful update
SuccessMessage
success
string
Examples
Parameters
attribute_def_id:
"value"
user_id:
"value"
application_id:
"value"
company_id:
"value"
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
400
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_overridden
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:
1
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
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_overridden
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
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
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
| 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
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
| date-time
modified_at
string
| date-time
__v
integer
page
object (PaginationSchema)
PaginationSchema
size
integer
The number of items per page.
item_total
integer
The total number of items across all pages.
has_next
boolean
Indicates whether there are more pages to retrieve.
type
string
The type of pagination used (eg Number).
current
integer
The current page number.
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000001"
page_no:
"1"
page_size:
"10"
type:
"test"
status:
"test"
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
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
| date-time
modified_at
string
| date-time
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000004"
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
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
| date-time
modified_at
string
| date-time
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000004"
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
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
| date-time
modified_at
string
| date-time
__v
integer
Examples
Parameters
company_id:
"559"
application_id:
"000000000000000000000004"
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
user_id
string
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
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
register_required_fields
object (RegisterRequiredFields)
RegisterRequiredFields
email
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
| date-time
register
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
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
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
register_required_fields
object (RegisterRequiredFields)
RegisterRequiredFields
email
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
| date-time
register
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
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
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
register_required_fields
object (RegisterRequiredFields)
RegisterRequiredFields
email
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
| date-time
register
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"
body:
body
Was this section helpful?
POST
Response