👥 Grupos WhatsApp

GroupAddParticipant

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/addParticipant

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

participantsstring[]Opcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/addParticipant

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/addParticipant HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "participants": [
    "5511999990001"
  ]
}

200

Successful response

GroupChangeDescription

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/changeDescription

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

descriptionstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/changeDescription

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/changeDescription HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "description": "Nova descrição do grupo"
}

200

Successful response

GroupChangePicture

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/changePicture

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

picturestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/changePicture

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/changePicture HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "picture": "https://exemplo.com/foto.jpg"
}

200

Successful response

GroupChangeTitle

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/changeTitle

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

titlestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/changeTitle

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/changeTitle HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "title": "Novo Título do Grupo"
}

200

Successful response

GroupCreate

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/create

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

titlesstring[]Opcional

numberstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/create

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/create HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "whatsappId": "{{whatsappId}}",
  "titles": [
    "Meu Grupo 1"
  ],
  "number": "5511999990001"
}

200

Successful response

GroupDemote

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/demote

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

participantsstring[]Opcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/demote

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/demote HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "participants": [
    "5511999990001"
  ]
}

200

Successful response

GroupGetInviteLink

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/getInviteLink

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/getInviteLink

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/getInviteLink HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "whatsappId": "{{whatsappId}}",
  "groupId": "{{groupId}}"
}

200

Successful response

GroupList

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/list

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/list

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/list HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "whatsappId": "{{whatsappId}}"
}

200

Successful response

GroupListParticipants

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/listParticipants

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/listParticipants

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/listParticipants HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ]
}

200

Successful response

GroupPromote

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/promote

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

participantsstring[]Opcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/promote

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/promote HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "participants": [
    "5511999990001"
  ]
}

200

Successful response

GroupRemoveParticipant

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/removeParticipant

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

participantsstring[]Opcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/removeParticipant

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/removeParticipant HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "participants": [
    "5511999990001"
  ]
}

200

Successful response

GroupSetAdminsOnly

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/setAdminsOnly

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdsstring[]Opcional

adminsOnlybooleanOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/setAdminsOnly

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/setAdminsOnly HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "adminsOnly": true
}

200

Successful response

GroupShowById

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/group/showById

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdstringOpcional

groupIdstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/group/showById

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/group/showById HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "whatsappId": "{{whatsappId}}",
  "groupId": "{{groupId}}"
}

200

Successful response