{"openapi":"3.0.3","info":{"version":"6.3","title":"Documentation MegaAPI","description":"This is a sample documentation for a new API.","contact":{"name":"MegaAPI","url":"https://mega-api.app.br"}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Your admin token"}},"schemas":{"Contact":{"type":"object","properties":{"to":{"type":"string","example":""},"fullName":{"type":"string","example":""},"firstName":{"type":"string","example":""},"lidJid":{"type":"string","example":""},"pnJid":{"type":"string","example":""},"username":{"type":"string","example":""},"saveOnPrimaryAddressbook":{"type":"boolean","example":true}}},"CreateLabel":{"type":"object","properties":{"labelId":{"type":"string","example":""},"name":{"type":"string","example":""},"color":{"type":"number","example":1}}},"EditLabel":{"type":"object","properties":{"labelId":{"type":"string","example":""},"name":{"type":"string","example":""},"color":{"type":"number","example":1},"deleted":{"type":"boolean","example":false}}},"ChatLabeled":{"type":"object","properties":{"chatId":{"type":"string","example":""},"messageId":{"type":"string","example":""},"labelId":{"type":"array","items":{"type":"string"},"example":[""]},"action":{"type":"string","example":"add"}}},"MediaMessageKeys":{"type":"object","properties":{"mediaKey":{"type":"string","example":""},"directPath":{"type":"string","example":""},"url":{"type":"string","example":""},"mimetype":{"type":"string","example":""},"messageType":{"type":"string","example":""}}},"ProfileStatus":{"type":"object","properties":{"status":{"type":"string","example":""}}},"ProfileName":{"type":"object","properties":{"name":{"type":"string","example":""}}},"BadRequest":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1,"example":"BAD_REQUEST","default":"BAD_REQUEST"},"message":{"type":"string","description":"An error message","minLength":1},"status":{"type":"number","description":"The status code of the exception","example":400,"default":400},"errors":{"type":"array","items":{"$ref":"#/components/schemas/GenericError"},"description":"A list of related errors"},"stack":{"type":"string","description":"The stack trace (only in development mode)"}},"required":["name","message","status"]},"GenericError":{"type":"object","properties":{"name":{"type":"string","description":"The error name","minLength":1},"message":{"type":"string","description":"An error message","minLength":1}},"additionalProperties":true,"required":["name","message"]},"ProfilePictureUrl":{"type":"object","properties":{"to":{"type":"string","example":""},"url":{"type":"string","example":""}}},"ProfilePictureBase64":{"type":"object","properties":{"to":{"type":"string","example":""},"base64":{"type":"string","example":""}}},"DisappearingModeSchema":{"type":"object","properties":{"to":{"type":"string","example":""},"duration":{"type":"number","example":604800}}},"ConfigWebhookSchema":{"type":"object","properties":{"webhookUrl":{"type":"string","example":""},"webhookEnabled":{"type":"boolean","example":true}}},"TextMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"text":{"type":"string","example":""},"linkPreview":{"type":"boolean","example":false}}},"TextMessageToMany":{"type":"object","properties":{"to":{"type":"array","items":{"type":"string"},"example":[""]},"text":{"type":"string","example":""},"linkPreview":{"type":"boolean","example":false}}},"TextMessageMentions":{"type":"object","properties":{"to":{"type":"string","example":""},"text":{"type":"string","example":""},"mentions":{"type":"array","items":{"type":"string"},"example":[""]}}},"CallOffer":{"type":"object","properties":{"to":{"type":"string","example":""},"isVideo":{"type":"boolean","example":false}}},"RejectCall":{"type":"object","properties":{"to":{"type":"string","example":""},"id":{"type":"string","example":""}}},"StatusMessage":{"type":"object","properties":{"text":{"type":"string","example":""},"textFont":{"type":"number","example":1},"textColor":{"type":"string","example":""},"backgroundColor":{"type":"string","example":""},"jidList":{"type":"array","items":{"type":"string"},"example":[""]}}},"MediaUrlMessageStatus":{"type":"object","properties":{"type":{"type":"string","example":""},"mimeType":{"type":"string","example":""},"caption":{"type":"string","example":""},"url":{"type":"string","example":""},"fileName":{"type":"string","example":""},"backgroundColor":{"type":"string","example":""},"jidList":{"type":"array","items":{"type":"string"},"example":[""]}}},"MediaBase64MessageStatus":{"type":"object","properties":{"base64":{"type":"string","example":""},"fileName":{"type":"string","example":""},"type":{"type":"string","example":""},"mimeType":{"type":"string","example":""},"caption":{"type":"string","example":""},"backgroundColor":{"type":"string","example":""},"jidList":{"type":"array","items":{"type":"string"},"example":[""]}}},"MediaUrlMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"url":{"type":"string","example":""},"fileName":{"type":"string","example":""},"type":{"type":"string","example":""},"caption":{"type":"string","example":""},"gifPlayback":{"type":"boolean","example":false},"mimeType":{"type":"string","example":""},"viewOnce":{"type":"boolean","example":false}}},"MediaUrlMessageToMany":{"type":"object","properties":{"to":{"type":"array","items":{"type":"string"},"example":[""]},"url":{"type":"string","example":""},"fileName":{"type":"string","example":""},"type":{"type":"string","example":""},"caption":{"type":"string","example":""},"gifPlayback":{"type":"boolean","example":false},"mimeType":{"type":"string","example":""},"viewOnce":{"type":"boolean","example":false}}},"MediaMessageBase64":{"type":"object","properties":{"to":{"type":"string","example":""},"base64":{"type":"string","example":""},"fileName":{"type":"string","example":""},"type":{"type":"string","example":""},"caption":{"type":"string","example":""},"gifPlayback":{"type":"boolean","example":false},"mimeType":{"type":"string","example":""},"viewOnce":{"type":"boolean","example":false}}},"MediaMessageBase64ToMany":{"type":"object","properties":{"to":{"type":"array","items":{"type":"string"},"example":[""]},"base64":{"type":"string","example":""},"fileName":{"type":"string","example":""},"type":{"type":"string","example":""},"caption":{"type":"string","example":""},"gifPlayback":{"type":"boolean","example":false},"mimeType":{"type":"string","example":""},"viewOnce":{"type":"boolean","example":false}}},"LocationMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"address":{"type":"string","example":""},"caption":{"type":"string","example":""},"latitude":{"type":"number","example":""},"longitude":{"type":"number","example":""},"url":{"type":"string","example":""}}},"LinkPreview":{"type":"object","properties":{"to":{"type":"string","example":""},"textWithLink":{"type":"string","example":""}}},"LinkPreviewToMany":{"type":"object","properties":{"to":{"type":"array","items":{"type":"string"},"example":[""]},"textWithLink":{"type":"string","example":""}}},"ReactMessage":{"type":"object","properties":{"text":{"type":"string","example":""},"key":{"type":"object","example":""}}},"ButtonMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"title":{"type":"string","example":""},"text":{"type":"string","example":""},"footer":{"type":"string","example":""},"type":{"type":"string","example":""},"mediaUrl":{"type":"string","example":""},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/TypeButton"}}}},"TypeButton":{"type":"object","properties":{"type":{"type":"string","example":""},"title":{"type":"string","example":""},"id":{"type":"string","example":""}}},"TemplateMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"title":{"type":"string","example":""},"text":{"type":"string","example":""},"footer":{"type":"string","example":""},"type":{"type":"string","example":""},"mediaUrl":{"type":"string","example":""},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/TypeTemplate"}}}},"TypeTemplate":{"type":"object","properties":{"type":{"type":"string","example":""},"title":{"type":"string","example":""},"payload":{"type":"string","example":""}}},"SendListMessageInteractive":{"type":"object","properties":{"to":{"type":"string","example":""},"buttonText":{"type":"string","example":""},"text":{"type":"string","example":""},"title":{"type":"string","example":""},"type":{"type":"string","example":""},"mediaUrl":{"type":"string","example":""},"gifPlayback":{"type":"boolean","example":false},"description":{"type":"string","example":""},"sections":{"type":"array","items":{"$ref":"#/components/schemas/ListSection"}}}},"ListSection":{"type":"object","properties":{"title":{"type":"string","example":""},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListRow"}}}},"ListRow":{"type":"object","properties":{"title":{"type":"string","example":""},"description":{"type":"string","example":""},"rowId":{"type":"string","example":""}}},"SendListMessageToMany":{"type":"object","properties":{"to":{"type":"array","items":{"type":"string"},"example":[""]},"buttonText":{"type":"string","example":""},"text":{"type":"string","example":""},"title":{"type":"string","example":""},"description":{"type":"string","example":""},"sections":{"type":"array","items":{"$ref":"#/components/schemas/ListSection"}}}},"SendListProductMessageData":{"type":"object","properties":{"to":{"type":"string","example":""},"text":{"type":"string","example":""},"title":{"type":"string","example":""},"description":{"type":"string","example":""},"productSections":{"type":"array","items":{"$ref":"#/components/schemas/ProductSection"}},"urlThumbnail":{"type":"string","example":""}}},"ProductSection":{"type":"object","properties":{"title":{"type":"string","example":""},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductsRow"}}}},"ProductsRow":{"type":"object","properties":{"productId":{"type":"string","example":""}}},"SendVCardData":{"type":"object","properties":{"to":{"type":"string","example":""},"vcard":{"$ref":"#/components/schemas/ContactData"}}},"ContactData":{"type":"object","properties":{"fullName":{"type":"string","example":""},"displayName":{"type":"string","example":""},"organization":{"type":"string","example":""},"phoneNumber":{"type":"string","example":""}}},"SendPollMessageData":{"type":"object","properties":{"to":{"type":"string","example":""},"title":{"type":"string","example":""},"selectableOptionsCount":{"type":"number","example":1},"options":{"type":"array","items":{"type":"string"},"example":[""]}}},"SendEditMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"key":{"type":"object","example":""},"newMessage":{"type":"string","example":""}}},"ForwardMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"key":{"type":"object","example":""},"message":{"type":"object","example":""}}},"QuoteMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"text":{"type":"string","example":""},"key":{"type":"object","example":""},"message":{"type":"object","example":""}}},"LastMessage":{"type":"object","properties":{"key":{"type":"object","example":""},"messageTimestamp":{"type":"number","example":0}}},"PinMessageInChat":{"type":"object","properties":{"key":{"type":"object","example":""},"duration":{"type":"number","example":0}}},"ReadMessage":{"type":"object","properties":{"key":{"type":"object","example":""}}},"DeleteMessageAndChat":{"type":"object","properties":{"to":{"type":"string","example":""},"key":{"type":"object","example":""},"messageTimestamp":{"type":"number","example":0}}},"LastMessageClearFromMe":{"type":"object","properties":{"id":{"type":"string","example":""},"timestamp":{"type":"number","example":0}}},"ClearChat":{"type":"object","properties":{"to":{"type":"string","example":""},"key":{"type":"object","example":""},"messageTimestamp":{"type":"number","example":0},"starredMessage":{"type":"boolean","example":true},"mediaFromDevice":{"type":"boolean","example":true}}},"StarMessageChat":{"type":"object","properties":{"to":{"type":"string","example":""},"option":{"type":"boolean","example":true},"key":{"type":"object","example":""}}},"GroupRequestParticipantsUpdate":{"type":"object","properties":{"to":{"type":"string","example":""},"participants":{"type":"array","items":{"type":"string"},"example":[""]},"action":{"type":"string","example":"approve"}}},"GroupSubject":{"type":"object","properties":{"jid":{"type":"string","example":""},"subject":{"type":"string","example":""}}},"GroupDescription":{"type":"object","properties":{"jid":{"type":"string","example":""},"description":{"type":"string","example":""}}},"GroupPictureUrl":{"type":"object","properties":{"to":{"type":"string","example":""},"url":{"type":"string","example":""}}},"GroupPictureBase64":{"type":"object","properties":{"to":{"type":"string","example":""},"base64":{"type":"string","example":""}}},"CreateGroupData":{"type":"object","properties":{"group_name":{"type":"string","example":""},"participants":{"type":"array","items":{"type":"string"},"example":[""]}}},"GroupData":{"type":"object","properties":{"jid":{"type":"string","example":""},"participants":{"type":"array","items":{"type":"string"},"example":[""]}}},"CreateProduct":{"type":"object","properties":{"name":{"type":"string","example":""},"url":{"type":"string","example":""},"description":{"type":"string","example":""},"priceAmount1000":{"type":"number","example":0},"currency":{"type":"string","example":"BRL"},"isHidden":{"type":"boolean","example":false},"retailerId":{"type":"string","example":""},"originCountryCode":{"type":"string","example":"BR"},"images":{"type":"array","items":{"$ref":"#/components/schemas/Url"},"example":[{"url":""}]}}},"Url":{"type":"object","properties":{"url":{"type":"string","example":""}}},"UpdateProduct":{"type":"object","properties":{"name":{"type":"string","example":""},"url":{"type":"string","example":""},"description":{"type":"string","example":""},"priceAmount1000":{"type":"number","example":0},"currency":{"type":"string","example":"BRL"},"isHidden":{"type":"boolean","example":false},"productId":{"type":"string","example":""},"retailerId":{"type":"string","example":""},"images":{"type":"array","items":{"$ref":"#/components/schemas/Url"},"example":[{"url":""}]}}},"ProductMessageSingle":{"type":"object","properties":{"to":{"type":"string","example":""},"productIds":{"type":"array","items":{"type":"string"},"example":[""]},"retailerIds":{"type":"array","items":{"type":"string"},"example":[""]}}},"DeleteProduct":{"type":"object","properties":{"productIds":{"type":"array","items":{"type":"string"},"example":[""]},"retailerIds":{"type":"array","items":{"type":"string"},"example":[""]}}},"VisibilityProduct":{"type":"object","properties":{"isHidden":{"type":"boolean","example":true},"productIds":{"type":"array","items":{"type":"string"},"example":[""]}}},"CreateCollection":{"type":"object","properties":{"name":{"type":"string","example":""},"productIds":{"type":"array","items":{"type":"string"},"example":[""]},"retailerIds":{"type":"array","items":{"type":"string"},"example":[""]}}},"CollectionMessageSingle":{"type":"object","properties":{"to":{"type":"string","example":""},"collectionId":{"type":"string","example":""}}},"OrderInfo":{"type":"object","properties":{"orderId":{"type":"string","example":""},"tokenBase64":{"type":"string","example":""}}},"OrderPaymentMessage":{"type":"object","properties":{"to":{"type":"string","example":""},"body":{"type":"string","example":""},"footer":{"type":"string","example":""},"imageThumbnail":{"type":"string","example":""},"orderId":{"type":"string","example":""},"tokenBase64":{"type":"string","example":""},"shipping":{"type":"number","example":1000},"discount":{"type":"number","example":1000},"tax":{"type":"number","example":1000},"paymentName":{"type":"string","example":""},"paymentKeyType":{"type":"string","example":""},"paymentKey":{"type":"string","example":""}}}}},"paths":{"/rest/instance/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - statusInstance","summary":"Get an status of instance","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/timeLock/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - timeLock","summary":"Get Reachout Timelock and Chat Message Cap","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/chats/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - chats","summary":"Get all your chats","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/messages/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - messages","summary":"Get messages from a specific chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"chat_id","required":false,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/contacts/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - contacts","summary":"Get all your contacts","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/lidPnMapping/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - lidPnMapping","summary":"Get your Lid/Pn Mapping","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/addContact/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - addContact","summary":"Add or Edit contact","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Contact"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/removeContact/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - removeContact","summary":"Remove contact","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/labels/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - labels","summary":"Get all your labels","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/labelAssociations/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - labelAssociations","summary":"Get all your labelAssociations","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/labels/createLabel/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - createLabel","description":"\n \n \n\n
\n \"Colors\"\n \"References\"\n
\n ","summary":"Create label","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CreateLabel"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/labels/editLabel/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - editLabel","description":"\n \n \n\n
\n \"Colors\"\n \"References\"\n
\n

For delete label -> \"deleted\": true

","summary":"Edit/Delete label","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EditLabel"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/labels/getChatLabels/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - getChatLabels","summary":"Get your chat in labels","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"chatId","required":false,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/labels/setChatLabels/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - setChatLabels","summary":"Set your chat in label","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ChatLabeled"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/downloadMediaMessage/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - downloadMediaMessage","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageKeys":{"$ref":"#/components/schemas/MediaMessageKeys"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/downloadMediaMessageFile/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - downloadMediaMessageFile","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageKeys":{"$ref":"#/components/schemas/MediaMessageKeys"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/getProfilePicture/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - getProfilePicture","summary":"Get image from any whatsapp profile","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"icon/image","in":"query","name":"type","required":false,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/setProfileStatus/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - setProfileStatus","summary":"Set profile status","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ProfileStatus"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/setProfileName/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - setProfileName","summary":"Set profile name","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ProfileName"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/setProfilePicture/{instance_key}":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"Instance - setProfilePicture","summary":"Set profile picture (LOCAL)","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/setProfilePictureUrl/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - setProfilePictureUrl","summary":"Set profile picture (URL)","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ProfilePictureUrl"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/setProfilePictureBase64/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - setProfilePictureBase64","summary":"Set profile picture (Base64)","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ProfilePictureBase64"}},"type":"object"}}}},"tags":["InstanceController"]}},"/rest/instance/isOnWhatsApp/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - isOnWhatsApp","summary":"Check if the number exists in whatsapp","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"jid","required":false,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/qrcode/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - qrcode","summary":"Get the qrcode","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/qrcode-img/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - qrcode-img","summary":"Get the qrcode image","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/qrcode_base64/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - qrcode_base64","summary":"Get the qrcode in base64 format","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/pairingCode/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - pairingCode","summary":"Get the pairing code to login","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"phoneNumber","required":false,"schema":{"type":"string"}},{"in":"query","name":"customPairingCode","required":false,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/{instance_key}/logout":{"delete":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - logout","summary":"Logout from an instance","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/instance/{instance_key}/restart":{"delete":{"responses":{"200":{"description":"Success"}},"operationId":"Instance - restart","summary":"Restart an instance","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["InstanceController"]}},"/rest/privacy/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - statusPrivacy","summary":"Get status all privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateLastSeen":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateLastSeen","description":"Options:

all
contacts
contact_blacklist
none
","summary":"Update the last seen privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"option":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateOnline":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateOnline","description":"Options:

all
match_last_seen
","summary":"Update the last seen privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"option":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateProfilePicture":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateProfilePicture","description":"Options:

all
contacts
contact_blacklist
none
","summary":"Update the profile picture privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"option":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateStatus":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateStatus","description":"Options:

all
contacts
contact_blacklist
none
","summary":"Update the status privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"option":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateReadReceipts":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateReadReceipts","description":"Options:

all
none
","summary":"Update the last seen privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"option":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateGroupsAdd":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateGroupsAdd","description":"Options:

all
contacts
contact_blacklist
none
","summary":"Update the groups add privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"option":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateCallAdd":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateCallAdd","description":"Options:

all
known
","summary":"Update the call privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"option":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/disappearingMode":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - disappearingMode","description":"Duration:

24 hours = 86400
7 days = 604800
90 days = 7776000
OFF = 0 or null
","summary":"Update disappearing mode","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/DisappearingModeSchema"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateMessages":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateMessages","description":"Options:

all
contacts
","summary":"Update the messages privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/privacy/{instance_key}/updateStickers":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Privacy - updateStickers","description":"Options:

contacts
contact_allowlist
none
","summary":"Update the stickers privacy","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"type":"string"}},"type":"object"}}}},"tags":["PrivacyController"]}},"/rest/webhook/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Webhook - statusWebhook","summary":"Get an instance webhook data","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["WebhookController"]}},"/rest/webhook/{instance_key}/configWebhook":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Webhook - configWebhook","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ConfigWebhookSchema"}},"type":"object"}}}},"tags":["WebhookController"]}},"/rest/sendMessage/{instance_key}/text":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - text","description":"Note that while sending to single chat, the id should not contain @s.whatsapp.net.
\n However, while sending to groups, the id should end with @g.us
\n ","summary":"Send a text message to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/TextMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/textToMany":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - textToMany","description":"Note that while sending to single chat, the id should not contain @s.whatsapp.net.
\n However, while sending to groups, the id should end with @g.us
\n ","summary":"Send a text message to multiple WhatsApp users","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/TextMessageToMany"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/textMentioned":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - textMentioned","description":"Note that while sending to single chat, the id should not contain @s.whatsapp.net.
\n However, while sending to groups, the id should end with @g.us
\n ","summary":"Send a text message to an WhatsApp User mentioned","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/TextMessageMentions"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/sendCall":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - sendCall","description":"
","summary":"Send a call to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/CallOffer"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/rejectCall":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - rejectCall","description":"
","summary":"Reject a call to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/RejectCall"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/sendMessageStories":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - sendMessageStories","description":"Sending a message to Stories/Status = status@broadcast

\n Fonts:
\n SYSTEM = 0
\n SYSTEM_TEXT = 1
\n FB_SCRIPT = 2
\n SYSTEM_BOLD = 6
\n MORNINGBREEZE_REGULAR = 7
\n CALISTOGA_REGULAR = 8
\n EXO2_EXTRABOLD = 9
\n COURIERPRIME_BOLD = 10
\n ","summary":"Send a message to Stories/Status","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/StatusMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/mediaUrlStories":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - mediaUrlStories","description":"The this endpoint allows you to send a media URL to a Stories/Status.\n
\n
\nThe type of media can be one of the following:\n\n
\n","summary":"Send a media message via a URL to Stories/Status","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/MediaUrlMessageStatus"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/mediaBase64Stories":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - mediaBase64Stories","description":"The this endpoint allows you to send a media URL to a Stories/Status.\n
\n
\nThe type of media can be one of the following:\n\n
\n","summary":"Send a media message via base64 to Stories/Status","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/MediaBase64MessageStatus"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/mediaUrl":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - mediaUrl","description":"The this endpoint allows you to send a media URL to a user.\n
\nThe url parameter is the URL of the media to be sent.\n
\nThe to parameter is the phone number of the user to send the media to.\n
\nThe type parameter is the type of media to be sent.\n
\nThe type of media can be one of the following:\n\n
\nThe caption parameter is the caption of the media to be sent.\n
\nThe mimeType parameter is the mimeType of the media.\n","summary":"Send a media message via a URL","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/MediaUrlMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/mediaUrlToMany":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - mediaUrlToMany","description":"The this endpoint allows you to send a media URL to a user.\n
\nThe url parameter is the URL of the media to be sent.\n
\nThe to parameter is the phone number of the user to send the media to.\n
\nThe type parameter is the type of media to be sent.\n
\nThe type of media can be one of the following:\n\n
\nThe caption parameter is the caption of the media to be sent.\n
\nThe mimeType parameter is the mimeType of the media.\n","summary":"Send a media message via a URL to many users","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/MediaUrlMessageToMany"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/mediaBase64":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - mediaBase64","description":"The this endpoint allows you to send a media Base64 to a user.\n
\nThe base64 parameter is the Base64 of the media to be sent.\n
\nThe to parameter is the phone number of the user to send the media to.\n
\nThe type parameter is the type of media to be sent.\n
\nThe type of media can be one of the following:\n\n
\nThe caption parameter is the caption of the media to be sent.\n
\nThe mimeType parameter is the mimeType of the media.\n","summary":"Send a media message via Base64","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/MediaMessageBase64"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/mediaBase64ToMany":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - mediaBase64ToMany","description":"The this endpoint allows you to send a media Base64 to a user.\n
\nThe base64 parameter is the Base64 of the media to be sent.\n
\nThe to parameter is the phone number of the user to send the media to.\n
\nThe type parameter is the type of media to be sent.\n
\nThe type of media can be one of the following:\n\n
\nThe caption parameter is the caption of the media to be sent.\n
\nThe mimeType parameter is the mimeType of the media.\n","summary":"Send a media message via Base64 to many users","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/MediaMessageBase64ToMany"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/image":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"SendMessage - image","summary":"Send an image message to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"in":"query","name":"caption","required":false,"schema":{"type":"string"}},{"in":"query","name":"viewOnce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/video":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"SendMessage - video","summary":"Send an video to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"in":"query","name":"caption","required":false,"schema":{"type":"string"}},{"in":"query","name":"gifPlayback","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"viewOnce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/audio":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"SendMessage - audio","summary":"Send an audio to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"in":"query","name":"viewOnce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/ptt":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"SendMessage - ptt","summary":"Send an audio(ptt) to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"in":"query","name":"viewOnce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/ptv":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"SendMessage - ptv","summary":"Send an video(ptv) to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"in":"query","name":"gifPlayback","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"viewOnce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/sticker":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"SendMessage - sticker","summary":"Send an sticker to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/document":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"SendMessage - document","summary":"Send an document to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"in":"query","name":"caption","required":false,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/location":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - location","summary":"Send an location to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/LocationMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/sendLinkPreview":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - sendLinkPreview","description":"Send a message with link preview","summary":"Send a message with link preview","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/LinkPreview"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/sendLinkPreviewToMany":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - sendLinkPreviewToMany","description":"Send a message with link preview to many Users","summary":"Send a message with link preview to many Users","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/LinkPreviewToMany"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/reactMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - reactMessage","description":"Send a React message","summary":"Send a React message to an WhatsApp User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"react":{"$ref":"#/components/schemas/ReactMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/buttonMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - buttonMessage","summary":"Send an interactive button message to an WhatsApp User","description":"The buttonMessage is a message that allows
\n you to send a message with buttons.
\n
\n How to send buttonMessage?
\n
\n The messageData object requires you to specify the name of button you
\n want to send to the user.
The type of button you can send are:
\n
\n reply

\n
\n Example of buttonMessage?
\n
\n
\n{
\n \"messageData\":{
\n \"to\": \"918788889688@s.whatsapp.net\",
\n \"title\": \"Message Title\",
\n \"text\": \"Message Text\",
\n \"footer\": \"Message Footer\",
\n \"type\": \"image\", // (\"text\" | \"image\" | \"video\" | \"document\")
\n \"mediaUrl\": \"https://www.example.com/imagem.jpg\",
\n \"buttons\":[
\n {
\n \"type\": \"reply\",
\n \"title\":\"Yes\"
\n },
\n {
\n \"type\": \"reply\",
\n \"title\":\"No\"
\n }
\n ]
\n }
\n}
\n \n
\n NOTE: \n Due to certain limitations of WhatsApp, the number of buttons is limited to 3 on mobile,
\n but on Whatsapp Web it shows several.
\n \n","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ButtonMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/templateMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - templateMessage","summary":"Send an interactive template button message to an WhatsApp User","description":"The templateMessage is a special type of message that allows
\n you to send a message with a special buttons like copyButton,
\n urlButton, callButton, etc.
\n
\n How to send templateMessage?
\n
\n The messageData object requires you to specify the type of button you
\n want to send to the user.
\n The type of button you can send are:
\n
\n copy

\n url

\n call

\n
\n In the payload field, you have to enter the payload
\n i.e. url in case of the url or phone number in case of call
\n
\n Example of templateMessage?
\n
\n
\n{
\n \"messageData\":{
\n \"to\": \"918788889688@s.whatsapp.net\",
\n \"title\": \"Message Title\",
\n \"text\": \"Message Text\",
\n \"footer\": \"Message Footer\",
\n \"type\": \"image\", // (\"text\" | \"image\" | \"video\" | \"document\")
\n \"mediaUrl\": \"https://www.example.com/imagem.jpg\",
\n \"buttons\": [
\n {
\n \"type\": \"copy\",
\n \"title\": \"This is a copyButton\"
\n \"payload\": \"Your text for copy\"
\n },
\n {
\n \"type\": \"url\",
\n \"title\": \"This is a urlButton\",
\n \"payload\": \"https://google.com\"
\n },
\n {
\n \"type\": \"call\",
\n \"title\": \"This is a callButton\",
\n \"payload\": \"918788889688\"
\n }
\n ]
\n }
\n}
\n \n
\n NOTE: \n Due to certain limitations from WhatsApp, when you send templateMessage to someone,
\n the message won't be visible in you phone. Also you will also see that the message has been sent
\n too your own phone number.
\n \n","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/TemplateMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/listMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - listMessage","summary":"Send an List Message to an User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/SendListMessageInteractive"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/listMessageToMany":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - listMessageToMany","summary":"Send an List Message to Many Users","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/SendListMessageToMany"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/listProductMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - listProductMessage","summary":"Send an List Product Message to an User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/SendListProductMessageData"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/contactMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - contactMessage","summary":"Send an Vcard message to an User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/SendVCardData"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/pollMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - pollMessage","summary":"Send an Poll message to an User or Group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/SendPollMessageData"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/editMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - editMessage","summary":"Edit message after send to User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/SendEditMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/forwardMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - forwardMessage","summary":"Forward message to User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ForwardMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/sendMessage/{instance_key}/quoteMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"SendMessage - quoteMessage","summary":"Quote message for User","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/QuoteMessage"}},"type":"object"}}}},"tags":["SendMessageController"]}},"/rest/chat/{instance_key}/presenceUpdateChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - presenceUpdateChat","description":"Option:

\"unavailable\"
\"available\"
\"composing\"
\"recording\"
\"paused\"","summary":"Change presence for chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"option":{"type":"string"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/archiveChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - archiveChat","summary":"Archive/Unarchive chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"option":{"type":"boolean"},"messageData":{"$ref":"#/components/schemas/LastMessage"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/pinChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - pinChat","summary":"Pin/Unpin chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"option":{"type":"boolean"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/pinMessageInChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - pinMessageInChat","description":"Duration:

24 hours = 86400
7 days = 604800
30 days = 2592000
Ever = -1
","summary":"Pin/Unpin message in chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"option":{"type":"boolean"},"messageData":{"$ref":"#/components/schemas/PinMessageInChat"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/muteStatus":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - muteStatus","summary":"Mute/Unmute Status","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"option":{"type":"boolean"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/blockChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - blockChat","summary":"Block/Unblock chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"option":{"type":"boolean"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/muteChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - muteChat","description":"Time:

8 hours = 8
1 Week = 168
Ever = -1
OFF = null","summary":"Mute/Unmute chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"time":{"type":"number"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/readMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - readMessage","summary":"Read message in chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ReadMessage"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/readChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - readChat","summary":"Read/Unread chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"option":{"type":"boolean"},"messageData":{"$ref":"#/components/schemas/LastMessage"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/deleteMessage":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - deleteMessage","summary":"Delete message in chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/DeleteMessageAndChat"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/deleteMessageFromMe":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - deleteMessageFromMe","summary":"Delete message fromMe in chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"to":{"type":"string"},"messageData":{"$ref":"#/components/schemas/LastMessageClearFromMe"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/deleteChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - deleteChat","summary":"Delete chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/DeleteMessageAndChat"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/clearChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - clearChat","summary":"Clear all messages in chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ClearChat"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/chat/{instance_key}/starMessageChat":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Chat - starMessageChat","summary":"Star message in chat","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/StarMessageChat"}},"type":"object"}}}},"tags":["ChatController"]}},"/rest/group/list/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - list","description":"List all groups and communitys","summary":"List all groups and communitys","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/adminGroups":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - adminGroups","description":"List all groups in which you are and admin","summary":"List all groups in which you are and admin","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/adminGroupsWithParticipants":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - adminGroupsWithParticipants","description":"List all groups in which you are and admin along with the participants array","summary":"List all groups in which you are and admin along with the participants array","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/groupRequestParticipantsList":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - groupRequestParticipantsList","summary":"Get a participants list","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/groupRequestParticipantsUpdate":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - groupRequestParticipantsUpdate","summary":"Get a participants update","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/GroupRequestParticipantsUpdate"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/group":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - groupInfo","description":"","summary":"Get a group info","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"jid","required":false,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/inviteInfo":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - inviteInfo","summary":"Get info group for inviteCode","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"code","required":false,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/groupInviteCode":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - groupInviteCode","description":"Get group invite code","summary":"Get group invite code","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"jid","required":false,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/groupRevokeInviteCode":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - groupRevokeInviteCode","description":"Revoke group invite code","summary":"Revoke group invite code","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"jid","required":false,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/groupAcceptInviteCode":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - groupAcceptInviteCode","summary":"Accept group invite code","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"code","required":false,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/sendLinkInviteGroup":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - sendLinkInviteGroup","description":"Send a link with invite group","summary":"Send a link with invite group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/LinkPreview"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/updateGroupSubject":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - updateGroupSubject","summary":"Update subject for group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/GroupSubject"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/updateGroupDescription":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - updateGroupDescription","summary":"Update description for group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/GroupDescription"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/updateGroupPicture":{"post":{"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":" [fieldName] Example: File too long file1"}},"operationId":"Groups - updateGroupPicture","summary":"Set group picture (LOCAL)","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/updateGroupPictureUrl":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - updateGroupPictureUrl","summary":"Set group picture (URL)","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/GroupPictureUrl"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/updateGroupPictureBase64":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - updateGroupPictureBase64","summary":"Set group picture (Base64)","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/GroupPictureBase64"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/create":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - create","description":"Please note that the participants should not contain @s.whatsapp.net","summary":"Create a group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"group_data":{"$ref":"#/components/schemas/CreateGroupData"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/addParticipants":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - addParticipants","description":"Please note that the participants should not contain @s.whatsapp.net
","summary":"Add participants to a group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"group_data":{"$ref":"#/components/schemas/GroupData"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/removeParticipants":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - removeParticipants","description":"Please note that the participants should not contain @s.whatsapp.net
","summary":"Remove participants from group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"group_data":{"$ref":"#/components/schemas/GroupData"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/demoteParticipants":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - demoteParticipants","description":"Please note that the participants should not contain @s.whatsapp.net
","summary":"Demote certain participants in group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"group_data":{"$ref":"#/components/schemas/GroupData"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/promoteParticipants":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - promoteParticipants","description":"Please note that the participants should not contain @s.whatsapp.net
","summary":"Promote certain participants in group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"group_data":{"$ref":"#/components/schemas/GroupData"}},"type":"object"}}}},"tags":["GroupController"]}},"/rest/group/{instance_key}/setWhoCanSendMessage":{"put":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - setWhoCanSendMessage","description":"Please note that the participants should not contain @s.whatsapp.net
","summary":"Set who can send message in group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"jid","required":false,"schema":{"type":"string"}},{"in":"query","name":"allowOnlyAdmins","required":false,"schema":{"type":"boolean"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/setWhoCanChangeSettings":{"put":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - setWhoCanChangeSettings","description":"Please note that the participants should not contain @s.whatsapp.net
","summary":"Set who can change settings of group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"jid","required":false,"schema":{"type":"string"}},{"in":"query","name":"allowOnlyAdmins","required":false,"schema":{"type":"boolean"}}],"tags":["GroupController"]}},"/rest/group/{instance_key}/leaveGroup":{"delete":{"responses":{"200":{"description":"Success"}},"operationId":"Groups - leaveGroup","description":"Leave group","summary":"Leave group","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"jid","required":false,"schema":{"type":"string"}}],"tags":["GroupController"]}},"/rest/product/listMyCatalog/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Products - listMyCatalog","description":"List my catalog","summary":"List my catalog","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}}],"tags":["ProductController"]}},"/rest/product/listCatalog/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Products - listCatalog","description":"List all catalogs","summary":"List all catalogs","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}}],"tags":["ProductController"]}},"/rest/product/sendCatalog/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - sendCatalog","description":"Send catalogs","summary":"Send catalogs","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"type":"object"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/createProduct/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - createProduct","description":"Create product","summary":"Create product","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/CreateProduct"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/updateProduct/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - updateProduct","description":"Update product","summary":"Update product","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/UpdateProduct"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/sendProduct/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - sendProduct","description":"Send product","summary":"Send product","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/ProductMessageSingle"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/infoProduct/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - infoProduct","description":"Send product","summary":"Info product","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/DeleteProduct"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/setProductVisibility/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - setProductVisibility","description":"Set product visibility","summary":"Info product","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/VisibilityProduct"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/deleteProduct/{instance_key}":{"delete":{"responses":{"200":{"description":"Success"}},"operationId":"Products - deleteProduct","description":"Delete product","summary":"Delete product","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/DeleteProduct"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/listMyCollection/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Products - listMyCollection","description":"List my collections","summary":"List my collections","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}}],"tags":["ProductController"]}},"/rest/product/listCollection/{instance_key}":{"get":{"responses":{"200":{"description":"Success"}},"operationId":"Products - listCollection","description":"List collections","summary":"List collections","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}}],"tags":["ProductController"]}},"/rest/product/createCollection/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - createCollection","description":"Create collection","summary":"Create collection","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/CreateCollection"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/sendCollection/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - sendCollection","description":"Send collection","summary":"Send collection","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/CollectionMessageSingle"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/deleteCollection/{instance_key}":{"delete":{"responses":{"200":{"description":"Success"}},"operationId":"Products - deleteCollection","description":"Delete collection","summary":"Delete collection","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}},{"in":"query","name":"id","required":false,"schema":{"type":"string"}}],"tags":["ProductController"]}},"/rest/product/getOrderInfo/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - getOrderInfo","description":"Get Order Details","summary":"Get Order Details","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/OrderInfo"}},"type":"object"}}}},"tags":["ProductController"]}},"/rest/product/sendOrderPayment/{instance_key}":{"post":{"responses":{"200":{"description":"Success"}},"operationId":"Products - sendOrderPayment","description":"Send order payment","summary":"Send order payment","security":[{"bearer":[]}],"parameters":[{"in":"path","name":"instance_key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"messageData":{"$ref":"#/components/schemas/OrderPaymentMessage"}},"type":"object"}}}},"tags":["ProductController"]}}},"tags":[{"name":"InstanceController","description":"Endpoints related to management of instances"},{"name":"PrivacyController","description":"Endpoints related to management of privacy"},{"name":"WebhookController","description":"Endpoints related to management of webhook"},{"name":"SendMessageController","description":"Endpoints related to management of messages"},{"name":"ChatController","description":"Endpoints related to management of chats"},{"name":"GroupController","description":"Endpoints related to management of groups"},{"name":"ProductController","description":"Endpoints related to management products (Beta)"}]}