🧩 Service: User​
🔧 Operation: getCustomers​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCustomers.methodTypePlaceHolder.parameters.2.required
🔹 Change 2​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCustomers.methodTypePlaceHolder.parameters.3.required
🔹 Change 3​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCustomers.methodTypePlaceHolder.parameters.4.required
🔹 Change 4​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.meta.properties
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema --> PhoneNumber - Schema Action:
PROPERTY_ADDED - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.phone_numbers.items.properties.rrid_linked - New Schema:
{
"type": "boolean",
"description": "Optional flag indicating this phone number is linked to an rrid for reconciliation. Present when available from social providers."
}
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.gender.nullable - New Schema:
true
🔹 Change 7​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format - New Schema:
"date-time"
🔹 Change 8​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.__v - New Schema:
{
"type": "number",
"description": "version indicator."
}
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.has_old_password_hash - New Schema:
{
"type": "boolean",
"description": "indicates if record contains old password hash."
}
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.debug - New Schema:
{
"$ref": "#/components/schemas/DebugInfo"
}
🔹 Change 12​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getCustomers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.social_accounts - New Schema:
{
"type": "array",
"description": "Social login accounts linked to the user.",
"items": {
"$ref": "#/components/schemas/SocialAccount"
}
}
🔹 Change 13​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCustomers.methodTypePlaceHolder.responses.400
🔹 Change 14​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCustomers.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: searchUsers​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.searchUsers.methodTypePlaceHolder.parameters.2.required
🔹 Change 2​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.searchUsers.methodTypePlaceHolder.parameters.3.required
🔹 Change 3​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.meta.properties
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema --> PhoneNumber - Schema Action:
PROPERTY_ADDED - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.phone_numbers.items.properties.rrid_linked - New Schema:
{
"type": "boolean",
"description": "Optional flag indicating this phone number is linked to an rrid for reconciliation. Present when available from social providers."
}
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.gender.nullable - New Schema:
true
🔹 Change 6​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.created_at.format - New Schema:
"date-time"
🔹 Change 7​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.__v - New Schema:
{
"type": "number",
"description": "version indicator."
}
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.has_old_password_hash - New Schema:
{
"type": "boolean",
"description": "indicates if record contains old password hash."
}
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.debug - New Schema:
{
"$ref": "#/components/schemas/DebugInfo"
}
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.searchUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.items.properties.social_accounts - New Schema:
{
"type": "array",
"description": "Social login accounts linked to the user.",
"items": {
"$ref": "#/components/schemas/SocialAccount"
}
}
🔹 Change 12​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.searchUsers.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: createUser​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserRequestSchema - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.createUser.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.additionalProperties - New Schema:
true
🔹 Change 2​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.meta.properties
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema --> PhoneNumber - Schema Action:
PROPERTY_ADDED - Path:
paths.createUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.phone_numbers.items.properties.rrid_linked - New Schema:
{
"type": "boolean",
"description": "Optional flag indicating this phone number is linked to an rrid for reconciliation. Present when available from social providers."
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserResponseSchema --> UserSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.createUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.gender.nullable - New Schema:
true
🔹 Change 5​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.created_at.format - New Schema:
"date-time"
🔹 Change 6​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserResponseSchema --> UserSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.password_last_modified - New Schema:
{
"type": "string"
}
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserResponseSchema --> UserSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.password_history - New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserPasswordHistory"
}
}
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserResponseSchema --> UserSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.social_accounts - New Schema:
{
"type": "array",
"description": "Social login accounts linked to the user.",
"items": {
"$ref": "#/components/schemas/SocialAccount"
}
}
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUser.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: blockOrUnblockUsers​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
BlockUserRequestSchema - Schema Action:
REQUIRED_ADDED - Path:
paths.blockOrUnblockUsers.methodTypePlaceHolder.requestBody.content.application/json.schema.required - New Schema:
[
"reason",
"user_id",
"status"
]
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.blockOrUnblockUsers.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: unDeleteUser​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
UnDeleteUserRequestSchema - Schema Action:
REQUIRED_ADDED - Path:
paths.unDeleteUser.methodTypePlaceHolder.requestBody.content.application/json.schema.required - New Schema:
[
"reason",
"reason_id",
"user_id"
]
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.unDeleteUser.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: updateUser​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
UpdateUserRequestSchema - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.updateUser.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.additionalProperties - New Schema:
true
🔹 Change 2​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.meta.properties
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CustomerListResponseSchema --> UserSearchSchema --> PhoneNumber - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.phone_numbers.items.properties.rrid_linked - New Schema:
{
"type": "boolean",
"description": "Optional flag indicating this phone number is linked to an rrid for reconciliation. Present when available from social providers."
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserResponseSchema --> UserSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.updateUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.gender.nullable - New Schema:
true
🔹 Change 5​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.created_at.format - New Schema:
"date-time"
🔹 Change 6​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserResponseSchema --> UserSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.password_last_modified - New Schema:
{
"type": "string"
}
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserResponseSchema --> UserSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.password_history - New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserPasswordHistory"
}
}
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserResponseSchema --> UserSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.social_accounts - New Schema:
{
"type": "array",
"description": "Social login accounts linked to the user.",
"items": {
"$ref": "#/components/schemas/SocialAccount"
}
}
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUser.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: createUserSession​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserSessionRequestSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUserSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.max_age - New Schema:
{
"type": "number"
}
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserSessionRequestSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUserSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.external_id - New Schema:
{
"description": "External id of the migrated user",
"type": "string"
}
🔹 Change 3​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserSessionRequestSchema - Schema Action:
REQUIRED_ADDED - Path:
paths.createUserSession.methodTypePlaceHolder.requestBody.content.application/json.schema.required - New Schema:
[
"domain",
"user_id"
]
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUserSession.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: deleteSession​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteSession.methodTypePlaceHolder.parameters.2.required
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteSession.methodTypePlaceHolder.parameters.5 - New Schema:
{
"name": "external_id",
"in": "query",
"description": "External ID of a customer.",
"schema": {
"type": "string"
},
"examples": {
"delete user session success": {
"value": "61f02c3dcc701256044ed6c0"
},
"delete user session failure": {
"value": ""
}
}
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
SessionDeleteResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.deleteSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.external_id - New Schema:
{
"type": "string"
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteSession.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: getActiveSessions​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getActiveSessions.methodTypePlaceHolder.parameters.2.required
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getActiveSessions.methodTypePlaceHolder.parameters.3 - New Schema:
{
"name": "external_id",
"in": "query",
"description": "External ID of a customer.",
"schema": {
"type": "string"
},
"examples": {
"delete user session success": {
"value": "61f02c3dcc701256044ed6c0"
},
"delete user session failure": {
"value": ""
}
}
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getActiveSessions.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: deleteActiveSessions​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteActiveSessions.methodTypePlaceHolder.parameters.2.required
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteActiveSessions.methodTypePlaceHolder.parameters.4 - New Schema:
{
"name": "external_id",
"in": "query",
"description": "External ID of a customer.",
"schema": {
"type": "string"
},
"examples": {
"delete user session success": {
"value": "61f02c3dcc701256044ed6c0"
},
"delete user session failure": {
"value": ""
}
}
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
SessionsDeleteResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.deleteActiveSessions.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.external_id - New Schema:
{
"type": "string"
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteActiveSessions.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: archiveUser​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
ArchiveUserRequestSchema - Schema Action:
REQUIRED_ADDED - Path:
paths.archiveUser.methodTypePlaceHolder.requestBody.content.application/json.schema.required - New Schema:
[
"user_id"
]
🔹 Change 2​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.archiveUser.methodTypePlaceHolder.responses.400
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.archiveUser.methodTypePlaceHolder.responses.404 - New Schema:
{
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"archive user failure": {
"value": {
"message": "No users found"
}
}
}
}
}
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.archiveUser.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: getPlatformConfig​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> Login - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.login.properties.via - New Schema:
{
"type": "string",
"enum": [
"email",
"phone",
"both"
]
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> Social - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.social.properties.truecaller - New Schema:
{
"type": "boolean"
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> RequiredFields - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.required_fields.properties.password - New Schema:
{
"$ref": "#/components/schemas/PlatformPassword"
}
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> RegisterRequiredFields - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.register_required_fields.properties.password - New Schema:
{
"$ref": "#/components/schemas/PlatformPassword"
}
🔹 Change 6​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_REMOVED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.social_tokens.properties.account_kit
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.social_tokens.properties.accountkit - New Schema:
{
"$ref": "#/components/schemas/Accountkit"
}
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.social_tokens.properties.truecaller - New Schema:
{
"$ref": "#/components/schemas/Truecaller"
}
🔹 Change 9​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.mobile_image.nullable - New Schema:
true
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.desktop_image.nullable - New Schema:
true
🔹 Change 12​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.account_lockout - New Schema:
{
"$ref": "#/components/schemas/AccountLockout"
}
🔹 Change 13​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.password_settings - New Schema:
{
"$ref": "#/components/schemas/PasswordSettings"
}
🔹 Change 14​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.jwt_config - New Schema:
{
"$ref": "#/components/schemas/JWTConfig"
}
🔹 Change 15​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.auth_method - New Schema:
{
"type": "string",
"enum": [
"session",
"jwt"
]
}
🔹 Change 16​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getPlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.retail_account - New Schema:
{
"$ref": "#/components/schemas/RetailAccount"
}
🔹 Change 17​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getPlatformConfig.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: updatePlatformConfig​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> Login - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.login.properties.via - New Schema:
{
"type": "string",
"enum": [
"email",
"phone",
"both"
]
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> Social - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.social.properties.truecaller - New Schema:
{
"type": "boolean"
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> RequiredFields - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.required_fields.properties.password - New Schema:
{
"$ref": "#/components/schemas/PlatformPassword"
}
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> RegisterRequiredFields - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.register_required_fields.properties.password - New Schema:
{
"$ref": "#/components/schemas/PlatformPassword"
}
🔹 Change 6​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_REMOVED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.social_tokens.properties.account_kit
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.social_tokens.properties.accountkit - New Schema:
{
"$ref": "#/components/schemas/Accountkit"
}
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.social_tokens.properties.truecaller - New Schema:
{
"$ref": "#/components/schemas/Truecaller"
}
🔹 Change 9​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.mobile_image.nullable - New Schema:
true
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.desktop_image.nullable - New Schema:
true
🔹 Change 12​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.account_lockout - New Schema:
{
"$ref": "#/components/schemas/AccountLockout"
}
🔹 Change 13​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.password_settings - New Schema:
{
"$ref": "#/components/schemas/PasswordSettings"
}
🔹 Change 14​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.jwt_config - New Schema:
{
"$ref": "#/components/schemas/JWTConfig"
}
🔹 Change 15​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.auth_method - New Schema:
{
"type": "string",
"enum": [
"session",
"jwt"
]
}
🔹 Change 16​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.retail_account - New Schema:
{
"$ref": "#/components/schemas/RetailAccount"
}
🔹 Change 17​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 18​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> Login - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.login.properties.via - New Schema:
{
"type": "string",
"enum": [
"email",
"phone",
"both"
]
}
🔹 Change 19​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> Social - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.social.properties.truecaller - New Schema:
{
"type": "boolean"
}
🔹 Change 20​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> RequiredFields - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.required_fields.properties.password - New Schema:
{
"$ref": "#/components/schemas/PlatformPassword"
}
🔹 Change 21​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> RegisterRequiredFields - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.register_required_fields.properties.password - New Schema:
{
"$ref": "#/components/schemas/PlatformPassword"
}
🔹 Change 22​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_REMOVED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.social_tokens.properties.account_kit
🔹 Change 23​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.social_tokens.properties.accountkit - New Schema:
{
"$ref": "#/components/schemas/Accountkit"
}
🔹 Change 24​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema --> SocialTokens - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.social_tokens.properties.truecaller - New Schema:
{
"$ref": "#/components/schemas/Truecaller"
}
🔹 Change 25​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 26​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.mobile_image.nullable - New Schema:
true
🔹 Change 27​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.desktop_image.nullable - New Schema:
true
🔹 Change 28​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.account_lockout - New Schema:
{
"$ref": "#/components/schemas/AccountLockout"
}
🔹 Change 29​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.password_settings - New Schema:
{
"$ref": "#/components/schemas/PasswordSettings"
}
🔹 Change 30​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.jwt_config - New Schema:
{
"$ref": "#/components/schemas/JWTConfig"
}
🔹 Change 31​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.auth_method - New Schema:
{
"type": "string",
"enum": [
"session",
"jwt"
]
}
🔹 Change 32​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PlatformSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.retail_account - New Schema:
{
"$ref": "#/components/schemas/RetailAccount"
}
🔹 Change 33​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updatePlatformConfig.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"company/settings/write"
]
}
]
🔧 Operation: createUserGroup​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserGroup --> ConditionsSchema - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.createUserGroup.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.conditions.items.properties.value.type - New Schema:
"object"
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserGroup --> ConditionsSchema - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.createUserGroup.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.conditions.items.properties.value.additionalProperties - New Schema:
true
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserGroup - Schema Action:
PROPERTY_ADDED - Path:
paths.createUserGroup.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.blacklisted_users - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateUserGroup - Schema Action:
PROPERTY_ADDED - Path:
paths.createUserGroup.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.category - New Schema:
{
"$ref": "#/components/schemas/CategorySchema"
}
🔹 Change 5​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema --> Conditions - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.createUserGroup.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.conditions.items.properties.value.type - New Schema:
"object"
🔹 Change 6​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUserGroup.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 7​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUserGroup.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.modified_at.format - New Schema:
"date-time"
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUserGroup.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.blacklisted_users - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUserGroup.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.total_users - New Schema:
{
"$ref": "#/components/schemas/TotalUserGroupUsers"
}
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUserGroup.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.tags - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.createUserGroup.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.category - New Schema:
{
"$ref": "#/components/schemas/CategorySchema"
}
🔹 Change 12​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUserGroup.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: getUserGroups​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.parameters.2.required
🔹 Change 2​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.parameters.3.required
🔹 Change 3​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.parameters.4.required
🔹 Change 4​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.parameters.5.required
🔹 Change 5​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
ENUM_REMOVED - Path:
paths.getUserGroups.methodTypePlaceHolder.parameters.5.schema.enum
🔹 Change 6​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.parameters.6.required
🔹 Change 7​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.parameters.7.required
🔹 Change 8​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema --> Conditions - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.getUserGroups.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.conditions.items.properties.value.type - New Schema:
"object"
🔹 Change 9​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format - New Schema:
"date-time"
🔹 Change 10​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_at.format - New Schema:
"date-time"
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getUserGroups.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.blacklisted_users - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 12​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getUserGroups.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.total_users - New Schema:
{
"$ref": "#/components/schemas/TotalUserGroupUsers"
}
🔹 Change 13​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getUserGroups.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.tags - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 14​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getUserGroups.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.category - New Schema:
{
"$ref": "#/components/schemas/CategorySchema"
}
🔹 Change 15​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroups.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: updateUserGroup​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserGroup --> ConditionsSchema - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.updateUserGroup.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.conditions.items.properties.value.type - New Schema:
"object"
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserGroup --> ConditionsSchema - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.updateUserGroup.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.conditions.items.properties.value.additionalProperties - New Schema:
true
🔹 Change 3​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema --> Conditions - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.updateUserGroup.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.conditions.items.properties.value.type - New Schema:
"object"
🔹 Change 4​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserGroup.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 5​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserGroup.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.modified_at.format - New Schema:
"date-time"
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroup.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.blacklisted_users - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroup.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.total_users - New Schema:
{
"$ref": "#/components/schemas/TotalUserGroupUsers"
}
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroup.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.tags - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroup.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.category - New Schema:
{
"$ref": "#/components/schemas/CategorySchema"
}
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserGroup.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: getUserGroupById​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema --> Conditions - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.getUserGroupById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.conditions.items.properties.value.type - New Schema:
"object"
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroupById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 3​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroupById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.modified_at.format - New Schema:
"date-time"
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getUserGroupById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.blacklisted_users - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getUserGroupById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.total_users - New Schema:
{
"$ref": "#/components/schemas/TotalUserGroupUsers"
}
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getUserGroupById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.tags - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getUserGroupById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.category - New Schema:
{
"$ref": "#/components/schemas/CategorySchema"
}
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserGroupById.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: updateUserGroupPartially​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PartialUserGroupUpdateSchema - Schema Action:
ENUM_VALUE_ADDED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.type.enum.2 - New Schema:
"black_list"
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PartialUserGroupUpdateSchema - Schema Action:
ENUM_VALUE_ADDED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.type.enum.3 - New Schema:
"white_list"
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PartialUserGroupUpdateSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.whitelisted_users - New Schema:
{
"type": "array",
"description": "List of user ids to be whitelisted from user group",
"items": {
"type": "string"
}
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
PartialUserGroupUpdateSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.blacklisted_users - New Schema:
{
"type": "array",
"description": "List of user ids to be blacklisted from user group",
"items": {
"type": "string"
}
}
🔹 Change 5​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema --> Conditions - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.conditions.items.properties.value.type - New Schema:
"object"
🔹 Change 6​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 7​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.modified_at.format - New Schema:
"date-time"
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.blacklisted_users - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.total_users - New Schema:
{
"$ref": "#/components/schemas/TotalUserGroupUsers"
}
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.tags - New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UserGroupResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.category - New Schema:
{
"$ref": "#/components/schemas/CategorySchema"
}
🔹 Change 12​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserGroupPartially.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: createUserAttributeDefinition​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserAttributeDefinition - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.createUserAttributeDefinition.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.default_value.type - New Schema:
"object"
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserAttributeDefinition - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.createUserAttributeDefinition.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.default_value.additionalProperties - New Schema:
true
🔹 Change 3​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserAttributeDefinition - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.createUserAttributeDefinition.methodTypePlaceHolder.requestBody.content.application/json.schema.additionalProperties - New Schema:
true
🔹 Change 4​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUserAttributeDefinition.methodTypePlaceHolder.responses.200
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUserAttributeDefinition.methodTypePlaceHolder.responses.201 - New Schema:
{
"description": "Success. returns created User Attribute Definition. `UserAttributeDefinitionResponse` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserAttributeDefinitionResp"
},
"examples": {
"success": {
"value": {
"_id": "5e68af49cfa09bf7233022f1",
"name": "example_name",
"slug": "example_key",
"description": "example_description",
"application_id": "application_id_example",
"type": "string",
"multi_value": false,
"customer_editable": true,
"encrypted": false,
"pinned": true,
"pin_order": 2,
"validations": [
{
"type": "min",
"value": 1
}
],
"is_locked": false,
"created_by": "5f6d1d7774e48a04969b2ea7",
"updated_by": "5f6d1d7774e48a04969b2ea7",
"created_at": "2023-10-17T10:00:00Z",
"modified_at": "2023-10-17T10:05:00Z"
}
}
}
}
}
}
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createUserAttributeDefinition.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: getUserAttributeDefinitions​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
ENUM_ADDED - Path:
paths.getUserAttributeDefinitions.methodTypePlaceHolder.parameters.2.schema.enum - New Schema:
[
"number",
"string",
"boolean",
"date",
"number_array",
"string_array",
"encrypted_string",
"encrypted_number",
"encrypted_string_array",
"encrypted_number_array"
]
🔹 Change 2​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitions.methodTypePlaceHolder.parameters.11.required
🔹 Change 3​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitions.methodTypePlaceHolder.parameters.12.required
🔹 Change 4​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitions.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format - New Schema:
"date-time"
🔹 Change 5​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitions.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_at.format - New Schema:
"date-time"
🔹 Change 6​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitions.methodTypePlaceHolder.responses.400
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitions.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: updateUserAttributeDefinition​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserAttributeDefinition - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.updateUserAttributeDefinition.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.default_value.type - New Schema:
"object"
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserAttributeDefinition - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.updateUserAttributeDefinition.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.default_value.additionalProperties - New Schema:
true
🔹 Change 3​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserAttributeDefinition - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.updateUserAttributeDefinition.methodTypePlaceHolder.requestBody.content.application/json.schema.additionalProperties - New Schema:
true
🔹 Change 4​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserAttributeDefinition.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 5​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserAttributeDefinition.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.modified_at.format - New Schema:
"date-time"
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserAttributeDefinition.methodTypePlaceHolder.responses.404 - New Schema:
{
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure2": {
"value": {
"message": "User Attribute Definition not found with Id: 5e68af49cfa09bf7233022f1"
}
}
}
}
}
}
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserAttributeDefinition.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: deleteUserAttributeDefinitionById​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteUserAttributeDefinitionById.methodTypePlaceHolder.responses.400
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteUserAttributeDefinitionById.methodTypePlaceHolder.responses.404 - New Schema:
{
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure": {
"value": {
"message": "`User Attribute Definition not found with Id: 000000000000000000000001"
}
}
}
}
}
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteUserAttributeDefinitionById.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: getUserAttributeDefinitionById​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitionById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format - New Schema:
"date-time"
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitionById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.modified_at.format - New Schema:
"date-time"
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitionById.methodTypePlaceHolder.responses.404 - New Schema:
{
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure": {
"value": {
"message": "User Attribute Definition not found with Id: 5e68af49cfa09bf7233022f1"
}
}
}
}
}
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeDefinitionById.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: updateUserAttribute​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserAttributePayload - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.updateUserAttribute.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.attribute.additionalProperties - New Schema:
true
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
CreateUserAttributePayload - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.updateUserAttribute.methodTypePlaceHolder.requestBody.content.application/json.schema.additionalProperties - New Schema:
true
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserAttribute.methodTypePlaceHolder.responses.201 - New Schema:
{
"description": "Successful update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserAttribute"
},
"examples": {
"success2": {
"value": {
"attribute": {
"key": "user_attribute:000000000000000000000001:000000000000000000000001:attribute1",
"value": "value"
},
"user_attribute_definition_id": "65b0f4c97a91e4327d7879f5",
"user_id": "000000000000000000000001",
"application_id": "000000000000000000000001",
"customer_overridden": false,
"type": "string",
"updated_by": "5e199e6998cfe1776f1385dc",
"_id": "65b0f4c97a91e4327d7879fd",
"created_at": "2024-01-24T11:30:17.958Z",
"modified_at": "2024-01-24T11:30:17.958Z",
"name": "Attribute Def 1",
"__v": 0
}
}
}
}
}
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateUserAttribute.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: getUserAttribute​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttribute.methodTypePlaceHolder.responses.400
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttribute.methodTypePlaceHolder.responses.404 - New Schema:
{
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure": {
"value": {
"message": "User Attributes not found for user with Id: 61f02c3dcc701256044ed6c0 and attribute defination id: 000000000000000000000001"
}
}
}
}
}
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttribute.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: deleteUserAttribute​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteUserAttribute.methodTypePlaceHolder.responses.400
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteUserAttribute.methodTypePlaceHolder.responses.404 - New Schema:
{
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure": {
"value": {
"message": "No attribute found."
}
}
}
}
}
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.deleteUserAttribute.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/write"
]
}
]
🔧 Operation: getUserAttributesForUser​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributesForUser.methodTypePlaceHolder.parameters.3.required
🔹 Change 2​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributesForUser.methodTypePlaceHolder.parameters.4.required
🔹 Change 3​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributesForUser.methodTypePlaceHolder.responses.400
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributesForUser.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: getUserAttributeById​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeById.methodTypePlaceHolder.responses.400
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeById.methodTypePlaceHolder.responses.404 - New Schema:
{
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure": {
"value": {
"message": "User Attribute not found with Id: 000000000000000000000001"
}
}
}
}
}
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getUserAttributeById.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/customers/read"
]
}
]
🔧 Operation: createUserSessionV2​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.createUserSessionV2 - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Create user session with separate access and refresh tokens",
"description": "Create user session with separate access and refresh token cookies",
"operationId": "createUserSessionV2",
"tags": [
"Customers"
],
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company ID",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"create user session v2 success": {
"value": "559"
},
"create user session v2 failure": {
"value": "559"
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application ID",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"create user session v2 success": {
"value": "000000000000000000000001"
},
"create user session v2 failure": {
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"description": "",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserSessionV2RequestSchema"
},
"examples": {
"create user session v2 failure": {
"value": {
"user_id": "",
"domain": ""
}
}
}
}
}
},
"responses": {
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"create user session v2 failure": {
"value": {
"message": "User not found"
}
}
}
}
}
}
},
"x-groups": [
"Customer Session"
],
"security": [
{
"oauth2": [
"application/customers/write"
]
}
],
"path": "/service/platform/user/v2.0/company/{company_id}/application/{application_id}/customers/session",
"methodType": "post"
}
}
🔧 Operation: getUserGroupCategories​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getUserGroupCategories - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get User Group Categories",
"description": "Retrieve a list of user group ctaegorie.",
"operationId": "getUserGroupCategories",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Numeric ID allotted to a business account on Fynd Platform.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "559"
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Alphanumeric ID allotted to an application created within a business account.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
}
],
"responses": {
"200": {
"description": "Success. User Group details. `UserGroupCategoriesResponseSchema` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGroupCategoriesResponseSchema"
},
"examples": {
"success": {
"value": {
"items": [
{
"name": "Level 1",
"key": "l1",
"description": "Level 1"
},
{
"name": "Level 2",
"key": "l2",
"description": "Level 2"
},
{
"name": "Default",
"key": "default_category",
"description": "Default"
}
]
}
}
}
}
}
}
},
"x-groups": [
"Customer Group"
],
"security": [
{
"oauth2": [
"application/customers/read"
]
}
],
"path": "/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/categories",
"methodType": "get"
}
}
🔧 Operation: getUsersByByGroupId​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getUsersByByGroupId - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get users belonging to user group by Id",
"description": "Use this API to users belonging to user Group",
"tags": [
"UserGroup"
],
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Numeric ID allotted to a business account on Fynd Platform.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "559"
},
"failure": {
"value": "559"
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Alphanumeric ID allotted to an application created within a business account.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"name": "group_id",
"in": "path",
"description": "Numeric ID allotted to a User Group",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "6345677535474fbb6944b7ce"
},
"failure": {
"value": "6345677535474fbb6944b7cf"
}
}
}
],
"operationId": "getUsersByByGroupId",
"responses": {
"200": {
"description": "Success. Users in User Group. `CustomerListResponseSchema` for more details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSearchSchema"
}
},
"page": {
"$ref": "#/components/schemas/CursorPaginationSchema"
}
}
},
"examples": {
"success": {
"value": {
"items": [
{
"_id": "000000000000000023106198",
"gender": "male",
"active": true,
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "raaz.crzy@gmail.com"
}
],
"username": "raaz_crzy_gmail_com_63747_23106198",
"__v": 7,
"debug": {
"source": "deadlock",
"platform": "000000000000000000000003"
},
"dob": "1995-07-23T00:00:00.000Z",
"account_type": "user",
"profile_pic_url": "https://hdn-1.fynd.com/user/profile/original/000000000000000023106198/1586498418772.jpg",
"first_name": "Prince",
"last_name": "Raj",
"phone_numbers": [
{
"active": true,
"primary": true,
"verified": true,
"phone": "7008963113",
"country_code": 91
}
],
"created_at": "2019-05-15T14:07:52.872Z",
"updated_at": "2020-09-21T06:38:41.388Z",
"has_old_password_hash": false
}
],
"page": {
"type": "number",
"current": 1,
"size": 10,
"has_next": false,
"has_prev": false,
"next_cursor": "6501aa22bb33cc44dd55ee66",
"prev_cursor": "6499aa22bb33cc44dd55ee11"
}
}
}
}
}
}
},
"404": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure": {
"value": {
"message": "No users found"
}
}
}
}
}
}
},
"x-groups": [
"Customer"
],
"security": [
{
"oauth2": [
"application/customers/read"
]
}
],
"path": "/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}/users",
"methodType": "get"
}
}
🔧 Operation: getCategorisedUserGroups​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getCategorisedUserGroups - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Categorised User Groups",
"operationId": "getCategorisedUserGroups",
"tags": [
"UserGroup"
],
"security": [
{
"oauth2": [
"application/customers/read"
]
}
],
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "Numeric ID allotted to a business account on Fynd Platform.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "559"
}
}
},
{
"in": "path",
"name": "application_id",
"description": "Alphanumeric ID allotted to an application.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_groups": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"total_users": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"updated_at": {
"type": "string"
}
}
}
}
}
}
}
}
},
"examples": {
"success": {
"value": {
"user_groups": {
"default_category": []
}
}
}
}
}
}
}
},
"x-groups": [
"Customer Group"
],
"path": "/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/categorised",
"methodType": "get"
}
}
🔧 Operation: getUserGroupTags​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getUserGroupTags - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get User Group Tags",
"operationId": "getUserGroupTags",
"tags": [
"UserGroup"
],
"security": [
{
"oauth2": [
"application/customers/read"
]
}
],
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "Numeric ID allotted to a business account on Fynd Platform.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "559"
}
}
},
{
"in": "path",
"name": "application_id",
"description": "Alphanumeric ID allotted to an application.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"examples": {
"success": {
"value": {
"items": []
}
}
}
}
}
}
},
"x-groups": [
"Customer Group"
],
"path": "/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/tags",
"methodType": "get"
}
}
🔧 Operation: refreshUserGroupTotalUsers​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.refreshUserGroupTotalUsers - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Refresh User Group Total Users",
"operationId": "refreshUserGroupTotalUsers",
"tags": [
"UserGroup"
],
"security": [
{
"oauth2": [
"application/customers/write"
]
}
],
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "Numeric ID allotted to a business account on Fynd Platform.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "559"
}
}
},
{
"in": "path",
"name": "application_id",
"description": "Alphanumeric ID allotted to an application.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshUserGroupTotalUsersRequestSchema"
},
"examples": {
"success": {
"value": {
"uid": 1
}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"uid": {
"type": "number"
}
}
},
"examples": {
"success": {
"value": {
"message": "Refresh initiated",
"uid": 1
}
}
}
}
}
}
},
"x-groups": [
"Customer Group"
],
"path": "/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/refresh-total-users",
"methodType": "post"
}
}
🔧 Operation: bulkUpdateUserAttributes​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.bulkUpdateUserAttributes - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Bulk Update User Attributes",
"description": "Update the same set of attributes for multiple users at once",
"tags": [
"UserAttribute"
],
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Numeric ID allotted to a business account on Fynd Platform.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "559"
},
"failure": {
"value": "559"
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Alphanumeric ID allotted to an application created within a business account.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000002"
}
}
}
],
"operationId": "bulkUpdateUserAttributes",
"requestBody": {
"description": "",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUpdateUserAttributesBody"
},
"examples": {
"success": {
"value": {
"users": [
"61f02c3dcc701256044ed6c0",
"66ace563cc2a001c4af52bae"
],
"attribute": [
{
"key": "attribute-2",
"value": 5
},
{
"key": "attribute-11",
"value": "test value"
}
]
}
},
"failure": {
"value": {
"users": [
"66ace563cc2a001c4af52bae"
],
"attribute": []
}
}
}
}
}
},
"responses": {
"200": {
"description": "Synchronous processing completed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkOperation"
},
"examples": {
"success": {
"value": {
"success": true,
"total": 2,
"processed": 2,
"errors_count": 0,
"errors": [],
"processing_type": "sync",
"error_summary": {}
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure": {
"value": {
"message": "Either users array or user_file_url is required"
}
}
}
}
}
}
},
"x-groups": [
"Customer Attributes"
],
"security": [
{
"oauth2": [
"application/customers/write"
]
}
],
"path": "/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/bulk_update",
"methodType": "put"
}
}
🔧 Operation: bulkUpdatePerUserAttributes​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.bulkUpdatePerUserAttributes - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Bulk Update Different Attributes Per User",
"description": "Update different sets of attributes for different users in a single request",
"tags": [
"UserAttribute"
],
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Numeric ID allotted to a business account on Fynd Platform.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "559"
},
"failure": {
"value": "559"
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Alphanumeric ID allotted to an application created within a business account.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
}
],
"operationId": "bulkUpdatePerUserAttributes",
"requestBody": {
"description": "",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUpdatePerUserAttributesBody"
},
"examples": {
"success": {
"value": {
"user_detail_attributes": [
{
"user_id": "000000000000000000000001",
"attributes": [
{
"key": "attribute1",
"value": "user1 value"
},
{
"key": "attribute2",
"value": 10
}
]
},
{
"user_id": "000000000000000000000002",
"attributes": [
{
"key": "attribute1",
"value": "user2 value"
},
{
"key": "attribute3",
"value": true
}
]
}
]
}
},
"failure": {
"value": {
"user_detail_attributes": []
}
}
}
}
}
},
"responses": {
"200": {
"description": "Operation completed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkOperation"
},
"examples": {
"success": {
"value": {
"success": true,
"total": 2,
"processed": 2,
"errors_count": 0,
"errors": [],
"processing_type": "sync"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIError"
},
"examples": {
"failure": {
"value": {
"message": "Request body must contain user data"
}
}
}
}
}
}
},
"x-groups": [
"Customer Attributes"
],
"security": [
{
"oauth2": [
"application/customers/write"
]
}
],
"path": "/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/bulk_update/per_user",
"methodType": "put"
}
}
🔧 Operation: checkUserGroupsExists​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.checkUserGroupsExists - New Schema:
{
"methodTypePlaceHolder": {
"summary": "Check if user belongs to specified user groups",
"operationId": "checkUserGroupsExists",
"tags": [
"UserGroup"
],
"description": "Check if user belongs to specified user groups",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Numeric ID allotted to a business account on Fynd Platform.",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "559"
}
}
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the user",
"examples": {
"success": {
"value": "66ace563cc2a001c4af52bae"
}
}
},
{
"name": "application_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the application",
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"name": "user_groups",
"in": "query",
"description": "Unique Group ids for which you want to check user.",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "number"
}
},
"examples": {
"success": {
"value": [
1
]
}
}
}
],
"responses": {
"200": {
"description": "User group existence result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGroupExists"
},
"examples": {
"success": {
"value": {
"user_groups": {
"123": true,
"456": false
}
}
}
}
}
}
}
},
"x-groups": [
"Customer Group"
],
"security": [
{
"oauth2": [
"application/customers/read"
]
}
],
"path": "/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/{user_id}/user-groups/exists",
"methodType": "get"
}
}