Send group invite - Notifique

curl --request POST \
  --url https://api.notifique.dev/v1/whatsapp/instances/{instanceId}/groups/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groups": [
    "120363295648424210@g.us"
  ],
  "to": [
    "5511999999999"
  ],
  "description": "Convite para o grupo"
}
'

{
  "success": true,
  "data": {
    "results": [
      {
        "groupJid": "120363130091228687@g.us",
        "success": true,
        "data": {
          "send": true,
          "inviteUrl": "https://chat.whatsapp.com/EYkW0HWQLJ7CS82xdLIu4i"
        }
      },
      {
        "groupJid": "120363048720182344@g.us",
        "success": true,
        "data": {
          "send": true,
          "inviteUrl": "https://chat.whatsapp.com/Gst4H0uNCjMFEwddWjWpm9"
        }
      }
    ]
  }
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

POST

instances

{instanceId}

groups

invite

curl --request POST \
  --url https://api.notifique.dev/v1/whatsapp/instances/{instanceId}/groups/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groups": [
    "120363295648424210@g.us"
  ],
  "to": [
    "5511999999999"
  ],
  "description": "Convite para o grupo"
}
'

{
  "success": true,
  "data": {
    "results": [
      {
        "groupJid": "120363130091228687@g.us",
        "success": true,
        "data": {
          "send": true,
          "inviteUrl": "https://chat.whatsapp.com/EYkW0HWQLJ7CS82xdLIu4i"
        }
      },
      {
        "groupJid": "120363048720182344@g.us",
        "success": true,
        "data": {
          "send": true,
          "inviteUrl": "https://chat.whatsapp.com/Gst4H0uNCjMFEwddWjWpm9"
        }
      }
    ]
  }
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

Authorizations

Authorization

string

header

required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Path Parameters

instanceId

string

required

Body

application/json

string[]

required

Números com DDI que receberão os links (ex.: 5511999999999)

Minimum array length: 1

groups

string[]

JIDs dos grupos cujo link será enviado. Um ou mais.

Required array length: 1 - 100 elements

Pattern: ^\d+@g\.us$

groupJid

string

Deprecated. Use groups. JID de um único grupo.

description

string

Text enviado com o convite (optional)

Response

data.results: um item por grupo. Sucesso: groupJid, success: true, data.send, data.inviteUrl. Falha: groupJid, success: false, error.

success

boolean

Example:

true

data

object

Show child attributes

Update group participants Revoke group invite