# whatsapp-business OpenAPI overview

> Below is an overview of the whatsapp-business openapi in simple language. This API contains 55 endpoints.

For more detailed information of an endpoint, visit https://oapis.org/summary/whatsapp-business/[idOrRoute]

WhatsApp Business API v1.0 - http://whatsapp.local
See https://developers.facebook.com/docs/whatsapp

## Application

- [SetShards](https://oapis.org/openapi/whatsapp-business/SetShards): POST http://whatsapp.local/account/shards - Set-Shards
- [GetApplicationSettings](https://oapis.org/openapi/whatsapp-business/GetApplicationSettings): GET http://whatsapp.local/settings/application - Get-Application-Settings
- [UpdateApplicationSettings](https://oapis.org/openapi/whatsapp-business/UpdateApplicationSettings): PATCH http://whatsapp.local/settings/application - Update-Application-Settings
- [ResetApplicationSettings](https://oapis.org/openapi/whatsapp-business/ResetApplicationSettings): DELETE http://whatsapp.local/settings/application - Reset-Application-Settings
- [GetMediaProviders](https://oapis.org/openapi/whatsapp-business/GetMediaProviders): GET http://whatsapp.local/settings/application/media/providers - Get-Media-Providers
- [UpdateMediaProviders](https://oapis.org/openapi/whatsapp-business/UpdateMediaProviders): POST http://whatsapp.local/settings/application/media/providers - Update-Media-Providers
- [DeleteMediaProviders](https://oapis.org/openapi/whatsapp-business/DeleteMediaProviders): DELETE http://whatsapp.local/settings/application/media/providers/{ProviderName} - Delete-Media-Providers

## Backup/Restore

- [BackupSettings](https://oapis.org/openapi/whatsapp-business/BackupSettings): POST http://whatsapp.local/settings/backup - Backup-Settings
- [RestoreSettings](https://oapis.org/openapi/whatsapp-business/RestoreSettings): POST http://whatsapp.local/settings/restore - Restore-Settings

## Business Profile

- [GetBusinessProfile](https://oapis.org/openapi/whatsapp-business/GetBusinessProfile): GET http://whatsapp.local/settings/business/profile - Get-Business-Profile
- [updateBusinessProfile](https://oapis.org/openapi/whatsapp-business/updateBusinessProfile): POST http://whatsapp.local/settings/business/profile - Update-Business-Profile

## Certificates

- [UploadCertificate](https://oapis.org/openapi/whatsapp-business/UploadCertificate): POST http://whatsapp.local/certificates/external - Upload-Certificate
- [DownloadCaCertificate](https://oapis.org/openapi/whatsapp-business/DownloadCaCertificate): GET http://whatsapp.local/certificates/external/ca - Download-CA-Certificate
- [DownloadWebhookCaCertificate](https://oapis.org/openapi/whatsapp-business/DownloadWebhookCaCertificate): GET http://whatsapp.local/certificates/webhooks/ca - Download Webhook CA Certificate
- [UploadWebhookCaCertificate](https://oapis.org/openapi/whatsapp-business/UploadWebhookCaCertificate): POST http://whatsapp.local/certificates/webhooks/ca - Upload Webhook CA Certificate
- [DeleteWebhookCaCertificate](https://oapis.org/openapi/whatsapp-business/DeleteWebhookCaCertificate): DELETE http://whatsapp.local/certificates/webhooks/ca - Delete Webhook CA Certificate

## Contacts

- [CheckContact](https://oapis.org/openapi/whatsapp-business/CheckContact): POST http://whatsapp.local/contacts - Check-Contact

## Groups

- [GetAllGroups](https://oapis.org/openapi/whatsapp-business/GetAllGroups): GET http://whatsapp.local/groups - Get-All-Groups
- [CreateGroup](https://oapis.org/openapi/whatsapp-business/CreateGroup): POST http://whatsapp.local/groups - Create-Group
- [GetGroupInfo](https://oapis.org/openapi/whatsapp-business/GetGroupInfo): GET http://whatsapp.local/groups/{GroupId} - Get-Group-Info
- [UpdateGroupInfo](https://oapis.org/openapi/whatsapp-business/UpdateGroupInfo): PUT http://whatsapp.local/groups/{GroupId} - Update-Group-Info
- [PromoteToGroupAdmin](https://oapis.org/openapi/whatsapp-business/PromoteToGroupAdmin): PATCH http://whatsapp.local/groups/{GroupId}/admins - Promote-To-Group-Admin
- [DemoteGroupAdmin](https://oapis.org/openapi/whatsapp-business/DemoteGroupAdmin): DELETE http://whatsapp.local/groups/{GroupId}/admins - Demote-Group-Admin
- [GetGroupIconBinary](https://oapis.org/openapi/whatsapp-business/GetGroupIconBinary): GET http://whatsapp.local/groups/{GroupId}/icon - Get-Group-Icon-Binary
- [SetGroupIcon](https://oapis.org/openapi/whatsapp-business/SetGroupIcon): POST http://whatsapp.local/groups/{GroupId}/icon - Set-Group-Icon
- [DeleteGroupIcon](https://oapis.org/openapi/whatsapp-business/DeleteGroupIcon): DELETE http://whatsapp.local/groups/{GroupId}/icon - Delete-Group-Icon
- [GetGroupInvite](https://oapis.org/openapi/whatsapp-business/GetGroupInvite): GET http://whatsapp.local/groups/{GroupId}/invite - Get-Group-Invite
- [DeleteGroupInvite](https://oapis.org/openapi/whatsapp-business/DeleteGroupInvite): DELETE http://whatsapp.local/groups/{GroupId}/invite - Delete-Group-Invite
- [LeaveGroup](https://oapis.org/openapi/whatsapp-business/LeaveGroup): POST http://whatsapp.local/groups/{GroupId}/leave - Leave-Group
- [RemoveGroupParticipant](https://oapis.org/openapi/whatsapp-business/RemoveGroupParticipant): DELETE http://whatsapp.local/groups/{GroupId}/participants - Remove-Group-Participant

## Health

- [CheckHealth](https://oapis.org/openapi/whatsapp-business/CheckHealth): GET http://whatsapp.local/health - Check-Health
- [GetMetrics](https://oapis.org/openapi/whatsapp-business/GetMetrics): GET http://whatsapp.local/metrics?format=string - Get-Metrics (since v2.21.3)
- [GetAppStats](https://oapis.org/openapi/whatsapp-business/GetAppStats): GET http://whatsapp.local/stats/app?format=string - Get-App-Stats
- [GetDbStats](https://oapis.org/openapi/whatsapp-business/GetDbStats): GET http://whatsapp.local/stats/db?format=string - Get-DB-Stats
- [GetSupportInfo](https://oapis.org/openapi/whatsapp-business/GetSupportInfo): GET http://whatsapp.local/support - Get-Support-Info

## Media

- [UploadMedia](https://oapis.org/openapi/whatsapp-business/UploadMedia): POST http://whatsapp.local/media - Upload-Media
- [DownloadMedia](https://oapis.org/openapi/whatsapp-business/DownloadMedia): GET http://whatsapp.local/media/{MediaId} - Download-Media
- [DeleteMedia](https://oapis.org/openapi/whatsapp-business/DeleteMedia): DELETE http://whatsapp.local/media/{MediaId} - Delete-Media

## Messages

- [SendMessage](https://oapis.org/openapi/whatsapp-business/SendMessage): POST http://whatsapp.local/messages - Send-Message
- [MarkMessageAsRead](https://oapis.org/openapi/whatsapp-business/MarkMessageAsRead): PUT http://whatsapp.local/messages/{MessageID} - Mark-Message-As-Read

## Profile

- [GetProfileAbout](https://oapis.org/openapi/whatsapp-business/GetProfileAbout): GET http://whatsapp.local/settings/profile/about - Get-Profile-About
- [UpdateProfileAbout](https://oapis.org/openapi/whatsapp-business/UpdateProfileAbout): PATCH http://whatsapp.local/settings/profile/about - Update-Profile-About
- [GetProfilePhoto](https://oapis.org/openapi/whatsapp-business/GetProfilePhoto): GET http://whatsapp.local/settings/profile/photo?format=string - Get-Profile-Photo
- [UpdateProfilePhoto](https://oapis.org/openapi/whatsapp-business/UpdateProfilePhoto): POST http://whatsapp.local/settings/profile/photo - Update-Profile-Photo

## Registration

- [RequestCode](https://oapis.org/openapi/whatsapp-business/RequestCode): POST http://whatsapp.local/account - Request-Code
- [RegisterAccount](https://oapis.org/openapi/whatsapp-business/RegisterAccount): POST http://whatsapp.local/account/verify - Register-Account

## Two-Step Verification

- [EnableTwoStep](https://oapis.org/openapi/whatsapp-business/EnableTwoStep): POST http://whatsapp.local/settings/account/two-step - Enable-Two-Step
- [DisableTwoStep](https://oapis.org/openapi/whatsapp-business/DisableTwoStep): DELETE http://whatsapp.local/settings/account/two-step - Disable-Two-Step

## Users

- [CreateUser](https://oapis.org/openapi/whatsapp-business/CreateUser): POST http://whatsapp.local/users - Create-User
- [LoginUser](https://oapis.org/openapi/whatsapp-business/LoginUser): POST http://whatsapp.local/users/login - Login-User
- [LogoutUser](https://oapis.org/openapi/whatsapp-business/LogoutUser): POST http://whatsapp.local/users/logout - Logout-User
- [GetUser](https://oapis.org/openapi/whatsapp-business/GetUser): GET http://whatsapp.local/users/{UserUsername} - Get-User
- [UpdateUser](https://oapis.org/openapi/whatsapp-business/UpdateUser): PUT http://whatsapp.local/users/{UserUsername} - Update-User
- [DeleteUser](https://oapis.org/openapi/whatsapp-business/DeleteUser): DELETE http://whatsapp.local/users/{UserUsername} - Delete-User

## Other

- [DeleteProfilePhoto](https://oapis.org/openapi/whatsapp-business/DeleteProfilePhoto): DELETE http://whatsapp.local/settings/profile/photo - Delete-Profile-Photo
