Skip to main content

User

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

Customer

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

Operations
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/list
# Get a List of Users
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/search
# Search an Existing Users
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers
# Create User
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/activation
# Block/Unblock Users
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/undelete
# Restore Deleted User
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/{user_id}
# Update User Details
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/archive
# Archive User
GET

Get a List of Users

Retrieve details of users registered in the sales channel
Parameters
q
string
Optional
The search query. Mobile number or email ID of a customer.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
pageNo
integer
Optional
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)
Optional
Array of UserSearchSchema
page
object (PaginationSchema)
Optional
PaginationSchema
Examples
Parameters
q:
"{"$or":[{"emails.email":"vinit.mav12@gofynd.com"},{"phoneNumbers.phone":"vinit.mav12@gofynd.com"}]}"
pageSize:
1
pageNo:
1
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/list
Loading...
Response
Example response not available.
GET

Search an Existing Users

Search and filter users details registered in the sales channel
Parameters
q
string
Optional
The search query. Mobile number or email ID of a customer.
query
array of string
Optional
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)
Optional
Array of UserSearchSchema
Examples
Parameters
q:
"vinit.mav12@gofynd.com"
query:
"vinit.mav12@gofynd.com"
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/search
Loading...
Response
Loading...
POST

Create User

Register and add a new user to the sales channel.
Parameters
body
object (CreateUserRequestSchema)
CreateUserRequestSchema
phone_number
string
email
string
Optional
first_name
string
Optional
last_name
string
Optional
gender
string
Optional
username
string
meta
object
Optional
external_id
string
Optional
rr_id
string
Optional
Response
200
400
User create
CreateUserResponseSchema
user
object (UserSchema)
Optional
UserSchema
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers
Loading...
Response
Loading...
PUT

Block/Unblock Users

Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked accounts.
Parameters
body
object (BlockUserRequestSchema)
BlockUserRequestSchema
status
boolean
Optional
user_id
array of string
Optional
reason
string
Optional
Response
200
400
Success
BlockUserSuccess
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/activation
Loading...
Response
Loading...
PUT

Restore Deleted User

Restore a previously deleted user account.
Parameters
body
object (UnDeleteUserRequestSchema)
UnDeleteUserRequestSchema
user_id
string
Optional
reason
string
Optional
reason_id
string
Optional
Response
200
400
Success
UnDeleteUserSuccess
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/undelete
Loading...
Response
Loading...
PUT

Update User Details

Modify and update user profile information.
Parameters
userId
string
User ID
body
object (UpdateUserRequestSchema)
UpdateUserRequestSchema
first_name
string
Optional
last_name
string
Optional
gender
string
Optional
external_id
string
Optional
rr_id
string
Optional
meta
object
Optional
phone_numbers
array of object (UserPhoneNumbers)
Optional
Array of UserPhoneNumbers
emails
array of object (UserEmails)
Optional
Array of UserEmails
Response
200
400
User update
CreateUserResponseSchema
user
object (UserSchema)
Optional
UserSchema
Examples
Parameters
userId:
"61f02c3dcc701256044ed6c0"
body:
body
Was this section helpful?
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/{user_id}
Loading...
Response
Loading...
PUT

Archive User

Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account.
Parameters
body
object (ArchiveUserRequestSchema)
ArchiveUserRequestSchema
user_id
string
Optional
Response
200
400
Success
ArchiveUserSuccess
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/archive
Loading...
Response
Loading...

Customer Attributes

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

Operations
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition
# Create a User Attribute Definition
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition
# Get User Attribute Definitions
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}
# Update User Attribute Definition
DEL
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}
# Delete User Attribute Definition
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}
# Get User Attribute Definition
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}
# Update Or Create User Attribute
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}
# Get User Attribute
DEL
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}
# Delete User Attribute
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/user/{user_id}
# Get All Customer Attributes
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/attribute/{attribute_id}
# Get User Attribute
POST

Create a User Attribute Definition

Create a new User Attribute Definition
Parameters
body
object (CreateUserAttributeDefinition)
CreateUserAttributeDefinition
name
string
Optional
slug
string
Optional
description
string
Optional
type
string
Optional
multi_value
boolean
Optional
customer_editable
boolean
Optional
encrypted
boolean
Optional
pinned
boolean
Optional
pin_order
number
Optional
default_value
string
Optional
validations
array of object
Optional
Response
200
400
Success. returns created User Attribute Definition. `UserAttributeDefinitionResponse` for more details.
UserAttributeDefinitionResponse
_id
string
Optional
The unique identifier for the attribute definition.
name
string
Optional
The attribute name.
slug
string
Optional
The attribute key.
description
string
Optional
The description of the attribute.
application_id
string
Optional
The application ID.
type
string
Optional
The attribute type.
Enum
multi_value
boolean
Optional
Whether the attribute supports multiple values.
customer_editable
boolean
Optional
Whether the attribute is customer-editable.
encrypted
boolean
Optional
Whether the attribute is encrypted.
pinned
boolean
Optional
Whether the attribute is pinned.
pin_order
integer
Optional
The order in which the attribute is pinned.
validations
array of object (UserAttributeDefinitionValidation)
Optional
Array of UserAttributeDefinitionValidation
is_locked
boolean
Optional
Whether the attribute is locked.
created_by
string
Optional
The user who created the attribute.
updated_by
string
Optional
The user who last updated the attribute.
created_at
string
| date-time
Optional
The creation date of the attribute definition.
modified_at
string
| date-time
Optional
The last modification date of the attribute definition.
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition
Loading...
Response
Loading...
GET

Get User Attribute Definitions

Retrieve user attribute definitions.
Parameters
excludingIds
string
Optional
Exclude attribute definitions by Ids
slug
string
Optional
Filter by attribute slug.
type
string
Optional
Filter by attribute type.
customerEditable
boolean
Optional
Filter by customer_editable status.
encrypted
boolean
Optional
Filter by encrypted status.
pinned
boolean
Optional
Filter by pinned status.
pinOrder
integer
Optional
Filter by pin order.
isLocked
boolean
Optional
Filter by locked status.
name
string
Optional
Filter by attribute name using a case-insensitive regex.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
pageNo
integer
Optional
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)
Optional
Array of UserAttributeDefinition
page
object
Optional
Properties
Examples
Parameters
excludingIds:
"value"
slug:
"value"
type:
"value"
customerEditable:
false
encrypted:
false
pinned:
false
pinOrder:
0
isLocked:
false
name:
"value"
pageSize:
0
pageNo:
0
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition
Loading...
Response
Loading...
PUT

Update User Attribute Definition

Update an existing user attribute definition.
Parameters
attributeDefId
string
The unique identifier of the attribute definition to update.
body
object (CreateUserAttributeDefinition)
CreateUserAttributeDefinition
name
string
Optional
slug
string
Optional
description
string
Optional
type
string
Optional
multi_value
boolean
Optional
customer_editable
boolean
Optional
encrypted
boolean
Optional
pinned
boolean
Optional
pin_order
number
Optional
default_value
string
Optional
validations
array of object
Optional
Response
200
400
Successful update
UserAttributeDefinition
_id
string
Optional
The unique identifier for the attribute definition.
name
string
Optional
The attribute name.
slug
string
Optional
The attribute key.
description
string
Optional
The description of the attribute.
application_id
string
Optional
The application ID.
type
string
Optional
The attribute type.
Enum
multi_value
boolean
Optional
Whether the attribute supports multiple values.
customer_editable
boolean
Optional
Whether the attribute is customer-editable.
encrypted
boolean
Optional
Whether the attribute is encrypted.
pinned
boolean
Optional
Whether the attribute is pinned.
pin_order
integer
Optional
The order in which the attribute is pinned.
validations
array of object
Optional
is_locked
boolean
Optional
Whether the attribute is locked.
created_at
string
Optional
The creation date of the attribute.
modified_at
string
Optional
The modification date of the attribute.
__v
integer
Optional
The version number of the attribute.
Examples
Parameters
attributeDefId:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}
Loading...
Response
Loading...
DEL

Delete User Attribute Definition

Delete a user attribute definition by its unique identifier.
Parameters
attributeDefId
string
The unique identifier of the attribute definition to delete.
Response
200
400
Successful Deletion
SuccessMessageResponse
success
string
Optional
Examples
Parameters
attributeDefId:
"value"
Was this section helpful?
DEL
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}
Loading...
Response
Loading...
GET

Get User Attribute Definition

Get a user attribute definition by its unique identifier.
Parameters
attributeDefId
string
The unique identifier of the attribute definition to retrieve.
Response
200
Successful Retrieval
UserAttributeDefinition
_id
string
Optional
The unique identifier for the attribute definition.
name
string
Optional
The attribute name.
slug
string
Optional
The attribute key.
description
string
Optional
The description of the attribute.
application_id
string
Optional
The application ID.
type
string
Optional
The attribute type.
Enum
multi_value
boolean
Optional
Whether the attribute supports multiple values.
customer_editable
boolean
Optional
Whether the attribute is customer-editable.
encrypted
boolean
Optional
Whether the attribute is encrypted.
pinned
boolean
Optional
Whether the attribute is pinned.
pin_order
integer
Optional
The order in which the attribute is pinned.
validations
array of object
Optional
is_locked
boolean
Optional
Whether the attribute is locked.
created_at
string
Optional
The creation date of the attribute.
modified_at
string
Optional
The modification date of the attribute.
__v
integer
Optional
The version number of the attribute.
Examples
Parameters
attributeDefId:
"value"
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}
Loading...
Response
Loading...
PUT

Update Or Create User Attribute

Update Or Create User Attribute
Parameters
attributeDefId
string
The unique identifier of the attribute definition to update.
userId
string
The unique identifier of the user to update.
body
object (CreateUserAttributeRequest)
CreateUserAttributeRequest
customer_overriden
boolean
Optional
attribute
object
Optional
Response
200
400
Successful update
UserAttributeResponse
_id
string
Optional
The unique identifier for the attribute definition.
name
string
Optional
The name of user attribute definition.
user_id
string
Optional
The unique identifier for the user.
application_id
string
Optional
The application ID.
type
string
Optional
The attribute type.
Enum
customer_overriden
boolean
Optional
Whether the attribute is customer-editable.
attribute
object
Optional
updated_by
string
Optional
Examples
Parameters
attributeDefId:
"value"
userId:
"value"
body:
body
Was this section helpful?
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}
Loading...
Response
Loading...
GET

Get User Attribute

Get User Attribute
Parameters
attributeDefId
string
The unique identifier of the attribute definition.
userId
string
The unique identifier of the user.
Response
200
400
Successful update
UserAttributeResponse
_id
string
Optional
The unique identifier for the attribute definition.
name
string
Optional
The name of user attribute definition.
user_id
string
Optional
The unique identifier for the user.
application_id
string
Optional
The application ID.
type
string
Optional
The attribute type.
Enum
customer_overriden
boolean
Optional
Whether the attribute is customer-editable.
attribute
object
Optional
updated_by
string
Optional
Examples
Parameters
attributeDefId:
"value"
userId:
"value"
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}
Loading...
Response
Loading...
DEL

Delete User Attribute

Delete User Attribute
Parameters
attributeDefId
string
The unique identifier of the attribute definition.
userId
string
The unique identifier of the user.
Response
200
400
Successful update
SuccessMessageResponse
success
string
Optional
Examples
Parameters
attributeDefId:
"value"
userId:
"value"
Was this section helpful?
DEL
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}
Loading...
Response
Loading...
GET

Get All Customer Attributes

Retrieve all user attributes for a specific user
Parameters
userId
string
The unique identifier of the user to update.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
Response
200
400
Successful update
Properties
items
array of object (UserAttributeResponse)
Optional
Array of UserAttributeResponse
page
object
Optional
Properties
Examples
Parameters
userId:
"value"
pageSize:
0
pageNo:
0
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/user/{user_id}
Loading...
Response
Loading...
GET

Get User Attribute

Retrieve User Attribute details by ID.
Parameters
attributeId
string
The unique identifier of the attribute to get.
Response
200
400
Successful update
UserAttributeResponse
_id
string
Optional
The unique identifier for the attribute definition.
name
string
Optional
The name of user attribute definition.
user_id
string
Optional
The unique identifier for the user.
application_id
string
Optional
The application ID.
type
string
Optional
The attribute type.
Enum
customer_overriden
boolean
Optional
Whether the attribute is customer-editable.
attribute
object
Optional
updated_by
string
Optional
Examples
Parameters
attributeId:
"value"
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/attribute/{attribute_id}
Loading...
Response
Loading...

Customer Group

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

Operations
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group
# Create User Group
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group
# Get User Groups
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}
# Update User Group
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}
# Get User Group
PATCH
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}
# Modify User Group
POST

Create User Group

Form and add a new user group.
Parameters
body
object (CreateUserGroup)
CreateUserGroup
conditions
array of object (ConditionsSchema)
Optional
Array of ConditionsSchema
type
string
Optional
name
string
description
string
file_url
string
Optional
Response
201
Success. returns created User Group. `UserGroupResponseSchema` for more details.
UserGroupResponseSchema
conditions
array of object (Conditions)
Optional
Array of Conditions
error
object (UserResponseErrorSchema)
Optional
UserResponseErrorSchema
name
string
Optional
description
string
Optional
file_url
string
Optional
_id
string
Optional
status
string
Optional
is_active
boolean
Optional
type
string
Optional
uid
integer
Optional
application_id
string
Optional
created_at
string
Optional
modified_at
string
Optional
__v
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group
Loading...
Response
Loading...
GET

Get User Groups

Retrieve a list of user groups.
Parameters
pageNo
string
Optional
page number for pagination result
pageSize
string
Optional
page size for pagination result
name
string
Optional
to search for User Groups which contains given string in their name
type
string
Optional
to search for User Groups with given type
Enum
status
string
Optional
to get User Groups with given status
groupUid
integer
Optional
to get User Groups with given uid
Response
200
Success. User Group details. `UserGroupListResponseSchema` for more details.
UserGroupListResponseSchema
items
array of object (UserGroupResponseSchema)
Optional
Array of UserGroupResponseSchema
page
object (PaginationSchema)
Optional
PaginationSchema
Examples
Parameters
pageNo:
"1"
pageSize:
"10"
type:
"test"
status:
"test"
groupUid:
30
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group
Loading...
Response
Loading...
PUT

Update User Group

Modify and update user group details.
Parameters
groupId
string
Numeric ID allotted to a User Group
body
object (UpdateUserGroupSchema)
UpdateUserGroupSchema
conditions
array of object (ConditionsSchema)
Optional
Array of ConditionsSchema
type
string
Optional
name
string
Optional
description
string
Optional
file_url
string
Optional
Response
200
404
Success. returns updated User Group. `UserGroupResponseSchema` for more details.
UserGroupResponseSchema
conditions
array of object (Conditions)
Optional
Array of Conditions
error
object (UserResponseErrorSchema)
Optional
UserResponseErrorSchema
name
string
Optional
description
string
Optional
file_url
string
Optional
_id
string
Optional
status
string
Optional
is_active
boolean
Optional
type
string
Optional
uid
integer
Optional
application_id
string
Optional
created_at
string
Optional
modified_at
string
Optional
__v
integer
Optional
Examples
Parameters
groupId:
"6345677535474fbb6944b7ce"
body:
body
Was this section helpful?
PUT
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}
Loading...
Response
Loading...
GET

Get User Group

Retrieve a user group by its unique identifier.
Parameters
groupId
string
Numeric ID allotted to a User Group
Response
200
404
Success. User Group details. `UserGroupResponseSchema` for more details.
UserGroupResponseSchema
conditions
array of object (Conditions)
Optional
Array of Conditions
error
object (UserResponseErrorSchema)
Optional
UserResponseErrorSchema
name
string
Optional
description
string
Optional
file_url
string
Optional
_id
string
Optional
status
string
Optional
is_active
boolean
Optional
type
string
Optional
uid
integer
Optional
application_id
string
Optional
created_at
string
Optional
modified_at
string
Optional
__v
integer
Optional
Examples
Parameters
groupId:
"6345677535474fbb6944b7ce"
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}
Loading...
Response
Loading...
PATCH

Modify User Group

Update user group partially on the platform.
Parameters
groupId
string
Numeric ID allotted to a User Group
body
object (PartialUserGroupUpdateSchema)
PartialUserGroupUpdateSchema
type
string
Optional
Source of update to be used to update individual users. Default value is considered file_url if not passed.
Enum
name
string
Optional
description
string
Optional
file_url
string
Optional
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)
Optional
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
Response
200
404
Success. returns updated User Group. `UserGroupResponseSchema` for more details.
UserGroupResponseSchema
conditions
array of object (Conditions)
Optional
Array of Conditions
error
object (UserResponseErrorSchema)
Optional
UserResponseErrorSchema
name
string
Optional
description
string
Optional
file_url
string
Optional
_id
string
Optional
status
string
Optional
is_active
boolean
Optional
type
string
Optional
uid
integer
Optional
application_id
string
Optional
created_at
string
Optional
modified_at
string
Optional
__v
integer
Optional
Examples
Parameters
groupId:
"6345677535474fbb6944b7ce"
body:
body
Was this section helpful?
PATCH
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}
Loading...
Response
Loading...

Customer Session

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

Operations
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session
# Create User Session
DEL
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session
# Delete User Session
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions
# Get User Active Sessions
DEL
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions
# Delete User Active Sessions
POST

Create User Session

Create session for user interactions
Parameters
body
object (CreateUserSessionRequestSchema)
CreateUserSessionRequestSchema
domain
string
Optional
max_age
number
Optional
user_id
string
Optional
Response
200
400
Create user session
CreateUserSessionResponseSchema
domain
string
Optional
max_age
number
Optional
secure
boolean
Optional
http_only
boolean
Optional
cookie
object
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session
Loading...
Response
Loading...
DEL

Delete User Session

Terminate an active user session.
Parameters
id
string
ID of a customer.
sessionId
string
Session ID of a customer.
reason
string
Reason for deleting session.
Response
200
400
Success. Refer `SessionDeleteResponseSchema` for more details.
SessionDeleteResponseSchema
user_id
string
Optional
session_id
string
Optional
Examples
Parameters
id:
"61f02c3dcc701256044ed6c0"
sessionId:
"000000000000000000000001"
reason:
"test"
Was this section helpful?
DEL
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session
Loading...
Response
Example response not available.
GET

Get User Active Sessions

Retrieve a list of currently active user sessions.
Parameters
id
string
ID of a customer.
Response
200
400
Success. Refer `SessionListResponseSchema` for more details.
SessionListResponseSchema
items
array of object (SessionListResponseInfo)
Optional
Array of SessionListResponseInfo
Examples
Parameters
id:
"61f02c3dcc701256044ed6c0"
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions
Loading...
Response
Example response not available.
DEL

Delete User Active Sessions

Terminate all active user sessions.
Parameters
id
string
ID of a customer.
reason
string
Reason to delete sessions.
Response
200
400
Success. Refer `SessionsDeleteResponseSchema` for more details.
SessionsDeleteResponseSchema
user_id
string
Optional
session_ids
array of string
Optional
Examples
Parameters
id:
"61f02c3dcc701256044ed6c0"
reason:
"test"
Was this section helpful?
DEL
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions
Loading...
Response
Example response not available.

Website Authentication

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

Operations
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/platform/config
# Get Platform Config
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/platform/config
# Update Platform Config
GET

Get Platform Config

Retrieve platform sales channel authentication configuration.
Parameters
No Parameters
Response
200
Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.
PlatformSchema
display
string
Optional
look_and_feel
object (LookAndFeel)
Optional
LookAndFeel
updated_at
string
Optional
active
boolean
Optional
forgot_password
boolean
Optional
login
object (Login)
Optional
Login
skip_captcha
boolean
Optional
name
string
Optional
meta
object (MetaSchema)
Optional
MetaSchema
_id
string
Optional
social
object (Social)
Optional
Social
required_fields
object (RequiredFields)
Optional
RequiredFields
register_required_fields
object (RegisterRequiredFields)
Optional
RegisterRequiredFields
skip_login
boolean
Optional
flash_card
object (FlashCard)
Optional
FlashCard
subtext
string
Optional
social_tokens
object (SocialTokens)
Optional
SocialTokens
created_at
string
Optional
register
boolean
Optional
mobile_image
string
Optional
desktop_image
string
Optional
delete_account_day
integer
Optional
delete_account_reasons
array of object (DeleteAccountReasons)
Optional
Array of DeleteAccountReasons
delete_account_consent
object (DeleteAccountConsent)
Optional
DeleteAccountConsent
session_config
object (SessionExpiry)
Optional
SessionExpiry
__v
integer
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/platform/config
Loading...
Response
Loading...
POST

Update Platform Config

Modify and update platform sales channel authentication configuration.
Parameters
body
object (PlatformSchema)
PlatformSchema
display
string
Optional
look_and_feel
object (LookAndFeel)
Optional
LookAndFeel
updated_at
string
Optional
active
boolean
Optional
forgot_password
boolean
Optional
login
object (Login)
Optional
Login
skip_captcha
boolean
Optional
name
string
Optional
meta
object (MetaSchema)
Optional
MetaSchema
_id
string
Optional
social
object (Social)
Optional
Social
required_fields
object (RequiredFields)
Optional
RequiredFields
register_required_fields
object (RegisterRequiredFields)
Optional
RegisterRequiredFields
skip_login
boolean
Optional
flash_card
object (FlashCard)
Optional
FlashCard
subtext
string
Optional
social_tokens
object (SocialTokens)
Optional
SocialTokens
created_at
string
Optional
register
boolean
Optional
mobile_image
string
Optional
desktop_image
string
Optional
delete_account_day
integer
Optional
delete_account_reasons
array of object (DeleteAccountReasons)
Optional
Array of DeleteAccountReasons
delete_account_consent
object (DeleteAccountConsent)
Optional
DeleteAccountConsent
session_config
object (SessionExpiry)
Optional
SessionExpiry
__v
integer
Optional
Response
200
Success. Returns a JSON object with the updated platform configurations. Refer `PlatformSchema` for more details.
PlatformSchema
display
string
Optional
look_and_feel
object (LookAndFeel)
Optional
LookAndFeel
updated_at
string
Optional
active
boolean
Optional
forgot_password
boolean
Optional
login
object (Login)
Optional
Login
skip_captcha
boolean
Optional
name
string
Optional
meta
object (MetaSchema)
Optional
MetaSchema
_id
string
Optional
social
object (Social)
Optional
Social
required_fields
object (RequiredFields)
Optional
RequiredFields
register_required_fields
object (RegisterRequiredFields)
Optional
RegisterRequiredFields
skip_login
boolean
Optional
flash_card
object (FlashCard)
Optional
FlashCard
subtext
string
Optional
social_tokens
object (SocialTokens)
Optional
SocialTokens
created_at
string
Optional
register
boolean
Optional
mobile_image
string
Optional
desktop_image
string
Optional
delete_account_day
integer
Optional
delete_account_reasons
array of object (DeleteAccountReasons)
Optional
Array of DeleteAccountReasons
delete_account_consent
object (DeleteAccountConsent)
Optional
DeleteAccountConsent
session_config
object (SessionExpiry)
Optional
SessionExpiry
__v
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/user/v1.0/company/{company_id}/application/{application_id}/platform/config
Loading...
Response
Loading...