Update User

Update User

PUT https://api.talkplus.io/v1.4/api/users/:userId

You can enter up to 5 key-value pairs in data field. The maximum size of key is 128 characters and the maximum size of value is 1024 characters. Both key and value must be strings.

Path Parameters

NameTypeDescription

userId*

string

Headers

NameTypeDescription

content-type

string

application/json

app-id*

string

App ID

api-key*

string

App API key

Request Body

NameTypeDescription

username

string

max char length: 128

profileImageUrl

string

data

object

Key-value data

{
  "user": {
    "id": "user456",
    "username": "john",
    "profileImageUrl": "http://cnd.test.com/123.jpg",
    "disablePushNotification": false,
    "data": {
      "someMetaKey1": "someMetaValue1",
      "someMetaKey2": "someMetaValue2"
    },
    "updatedAt": 1603244410844,
    "createdAt": 1603244410844
  }
}

Update User / Upload Profile Image File

PUT https://api.talkplus.io/v1.4/api/users/:userId

  • In case of image file upload, Content-Type must be multipart/form-data.

  • Maximum upload size is 15MB.

  • You can enter up to 5 key-value pairs in data field. The maximum size of key is 128 characters and the maximum size of value is 1024 characters. Both key and value must be strings.

Path Parameters

NameTypeDescription

userId*

string

Headers

NameTypeDescription

content-type

string

must be "multipart/form-data"

app-id*

string

App ID

api-key*

string

App API key

Request Body

NameTypeDescription

username

string

max char length: 128

data

object

JSON formatted string

file

string

File

{
  "user": {
    "id": "user456",
    "username": "john",
    "profileImageUrl": "http://cnd.test.com/123.jpg",
    "disablePushNotification": false,
    "data": {
      "someMetaKey1": "someMetaValue1",
      "someMetaKey2": "someMetaValue2"
    },
    "updatedAt": 1603244410844,
    "createdAt": 1603244410844
  }
}

Change User Password

PUT https://api.talkplus.io/v1.4/api/users/:userId/password

Change user password

There is no length limit, but if the password is longer than 72 characters, only the first 72 characters will be considered.

Path Parameters

NameTypeDescription

userId*

string

Headers

NameTypeDescription

content-type

string

application/json

app-id*

string

App ID

api-key*

string

App API key

Request Body

NameTypeDescription

password*

string

new password. There is no length limit, but if the password is longer than 72 characters, only the first 72 characters will be considered.

{
  "user": {
    "id": "user456",
    "username": "john",
    "profileImageUrl": "http://cnd.test.com/123.jpg",
    "disablePushNotification": false,
    "data": {
      "someMetaKey1": "someMetaValue1",
      "someMetaKey2": "someMetaValue2"
    },
    "updatedAt": 1603244410844,
    "createdAt": 1603244410844
  },
  "loginToken": "sfZtlsgkf3tLLk5H245dsK"
}

Register FCM Token

POST https://api.talkplus.io/v1.4/api/users/:userId/register/fcm

Register FCM token for specific user

Path Parameters

NameTypeDescription

userId*

string

user ID

Headers

NameTypeDescription

content-type*

string

application/json

app-id*

string

App ID

api-key*

string

App API key

Request Body

NameTypeDescription

deviceId*

string

device ID to which FCM token will be registered

fcmToken*

string

FCM token

{}

Last updated