Move WhatApp

PATCH 
/api/v2/business/:businessId/instance/move-whatsapp

This functionality allows companies associated with the business to manage the reallocation of WhatsApp numbers between their instances, providing flexibility and control over communication with customers.

Request

Path Parameters

businessId stringrequired

Business ID.

application/json

Body

required

sourceWhatsAppId Source WhatsApprequired
instanceIdTarget Instance Targetrequired

Responses

200

BusinessMoveWAResponse

application/json

Schema

Schema

instanceId stringrequired
name stringrequired
state stringrequired

Default value: active | inactive

connection stringrequired

Default value: open | close | refused

createdAt date-timerequired
deletedAt date-timerequired
businessBusinessId stringrequired
Auth object
authId stringrequired
jwt stringrequired
createdAt date-timerequired
updatedAt date-timerequired
WhatsApp object
whatsappId stringrequired
remoteJid stringrequired
pictureUrl stringrequired
pushName stringrequired
createdAt stringrequired

Example (from schema)

{
  "instanceId": "string",
  "name": "string",
  "state": "active | inactive",
  "connection": "open | close | refused",
  "createdAt": "2024-04-14T14:11:05.629Z",
  "deletedAt": "2024-04-14T14:11:05.629Z",
  "businessBusinessId": "string",
  "Auth": {
    "authId": "string",
    "jwt": "string",
    "createdAt": "2024-04-14T14:11:05.629Z",
    "updatedAt": "2024-04-14T14:11:05.629Z"
  },
  "WhatsApp": {
    "whatsappId": "string",
    "remoteJid": "string",
    "pictureUrl": "string",
    "pushName": "string",
    "createdAt": "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...