Updating information

PUT 
/api/v2/instance/:instanceId/socket

Updating information

Request

Path Parameters

instanceId stringrequired

ID of the instance.

application/json

Body

required

enabled Enabled
events object

qrcodeUpdate QrCode Update

Default value: true

Enables sending the qr code.

stateInstance State Instance

Default value: false

Enables sending instance State.

messagesSet Messages Set

Default value: false

Enables batch sending of old messages.

messagesUpsert Messages Upsert

Default value: true

Enables sending of all new incoming messages.

messagesUpdate Messages Update

Default value: true

Enables sending all updates to the incoming or outgoing message.

sendMessage Send Message

Default value: true

Enables the sending of all messages sent by the API.

contactsSet Contacts Set

Default value: false

Enables sending the initial batch of loaded contacts.

contactsUpsert Contacts Upsert

Default value: false

Enables sending a new contact with additional information.

contactsUpdate Contacts Update

Default value: false

Enable update notification for each contact in the conversation.

presenceUpdate Presence Update

Default value: true

Enables notification of contact behavior in chat.

chatsSet Chat Set

Default value: false

Enables sending all loaded chats.

chatsUpdate Chat Set

Default value: false

Enable notification of each chat update in the conversation.

chatsUpsert Chat Upsert

Default value: false

Enable notification of every new chat started.

chatsDelete Chat Deletedeprecated

Default value: false

Enable notification when a chat is deleted.

groupsUpsert Group Upsert

Default value: false

Enable notification when a group is created.

groupUpdate Group Update

Default value: false

c

groupParticipantsUpdate Group Participant Update

Default value: false

Enable notification when a member of a group is updated.

connectionUpdate Connection Update

Default value: true

Enable notification when connection status changes.

callUpsert Call Upsert

Default value: false

Responses

201

ResponseSocket

application/json

Schema

Schema

socketId stringrequired
enabled booleanrequired
SocketEvents object

qrcodeUpdate QrCode Update

Default value: true

Enables sending the qr code.

stateInstance State Instance

Default value: false

Enables sending instance State.

messagesSet Messages Set

Default value: false

Enables batch sending of old messages.

messagesUpsert Messages Upsert

Default value: true

Enables sending of all new incoming messages.

messagesUpdate Messages Update

Default value: true

Enables sending all updates to the incoming or outgoing message.

sendMessage Send Message

Default value: true

Enables the sending of all messages sent by the API.

contactsSet Contacts Set

Default value: false

Enables sending the initial batch of loaded contacts.

contactsUpsert Contacts Upsert

Default value: false

Enables sending a new contact with additional information.

contactsUpdate Contacts Update

Default value: false

Enable update notification for each contact in the conversation.

presenceUpdate Presence Update

Default value: true

Enables notification of contact behavior in chat.

chatsSet Chat Set

Default value: false

Enables sending all loaded chats.

chatsUpdate Chat Set

Default value: false

Enable notification of each chat update in the conversation.

chatsUpsert Chat Upsert

Default value: false

Enable notification of every new chat started.

chatsDelete Chat Deletedeprecated

Default value: false

Enable notification when a chat is deleted.

groupsUpsert Group Upsert

Default value: false

Enable notification when a group is created.

groupUpdate Group Update

Default value: false

c

groupParticipantsUpdate Group Participant Update

Default value: false

Enable notification when a member of a group is updated.

connectionUpdate Connection Update

Default value: true

Enable notification when connection status changes.

callUpsert Call Upsert

Default value: false

createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired
instanceInstanceId stringrequired

Example (from schema)

{
  "socketId": "string",
  "enabled": true,
  "SocketEvents": {
    "qrcodeUpdate": true,
    "stateInstance": false,
    "messagesSet": false,
    "messagesUpsert": true,
    "messagesUpdate": true,
    "sendMessage": true,
    "contactsSet": false,
    "contactsUpsert": false,
    "contactsUpdate": false,
    "presenceUpdate": true,
    "chatsSet": false,
    "chatsUpdate": false,
    "chatsUpsert": false,
    "groupsUpsert": false,
    "groupUpdate": false,
    "groupParticipantsUpdate": false,
    "connectionUpdate": true,
    "callUpsert": false
  },
  "createdAt": "2024-04-14T14:11:06.347Z",
  "updatedAt": "2024-04-14T14:11:06.347Z",
  "deletedAt": "2024-04-14T14:11:06.347Z",
  "instanceInstanceId": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...