WhatsApp Business API
  1. Users
WhatsApp Business API
  • Registration
    • Request-Code
      POST
    • Register-Account
      POST
  • Application
    • Set-Shards
      POST
    • Reset-Application-Settings
      DELETE
    • Get-Application-Settings
      GET
    • Update-Application-Settings
      PATCH
    • Get-Media-Providers
      GET
    • Update-Media-Providers
      POST
    • Delete-Media-Providers
      DELETE
  • Certificates
    • Upload-Certificate
      POST
    • Download-CA-Certificate
      GET
    • Delete Webhook CA Certificate
      DELETE
    • Download Webhook CA Certificate
      GET
    • Upload Webhook CA Certificate
      POST
  • Contacts
    • Check-Contact
      POST
  • Groups
    • Get-All-Groups
      GET
    • Create-Group
      POST
    • Get-Group-Info
      GET
    • Update-Group-Info
      PUT
    • Demote-Group-Admin
      DELETE
    • Promote-To-Group-Admin
      PATCH
    • Delete-Group-Icon
      DELETE
    • Get-Group-Icon-Binary
      GET
    • Set-Group-Icon
      POST
    • Delete-Group-Invite
      DELETE
    • Get-Group-Invite
      GET
    • Leave-Group
      POST
    • Remove-Group-Participant
      DELETE
  • Health
    • Check-Health
    • Get-Metrics (since v2.21.3)
    • Get-App-Stats
    • Get-DB-Stats
    • Get-Support-Info
  • Media
    • Upload-Media
    • Delete-Media
    • Download-Media
  • Messages
    • Send-Message
    • Mark-Message-As-Read
  • Two-Step Verification
    • Disable-Two-Step
    • Enable-Two-Step
  • Backup
    • Restore
      • Backup-Settings
      • Restore-Settings
  • Business Profile
    • Get-Business-Profile
    • Update-Business-Profile
  • Profile
    • Get-Profile-About
    • Update-Profile-About
    • Get-Profile-Photo
    • Update-Profile-Photo
  • Users
    • Create-User
      POST
    • Login-User
      POST
    • Logout-User
      POST
    • Delete-User
      DELETE
    • Get-User
      GET
    • Update-User
      PUT
  • Delete-Profile-Photo
    DELETE
  1. Users

Login-User

http://whatsapp.local
http://whatsapp.local
POST
/users/login
Users
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://whatsapp.local/users/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "new_password": "<New Admin Password>"
}'
Response Response Example
{
  "users": [
    {
      "expires_after": "2018-03-01T15:29:26.000Z",
      "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo"
    }
  ]
}

Request

Body Params application/json
new_password
string 
required
Examples

Responses

🟢200OK
application/json
Body
errors
array[object (Error) {4}] 
optional
Only returned with a failed request. Contains an array of error objects that are present when there is an error.
code
integer <int32>
optional
See the https://developers.facebook.com/docs/whatsapp/api/errors for more information.
details
string 
optional
error detail
href
string 
optional
location for error detail
title
string 
optional
error title
meta
object 
Meta
optional
Contains generic information such as WhatsApp Business API Client version.
Example:
{"api_status":"stable","version":"whatsapp-business-api-client-version"}
api_status
enum<string> 
optional
Allowed values:
deprecatedexperimentalstable
version
string 
optional
users
array[object (UserLoginResponseItem) {2}] 
optional
expires_after
string <date-time>
optional
Token expiration timestamp. By default, this is 7 days.
token
string 
optional

Authentication token to be used for all other WhatsApp Business API calls. The token must be sent in the authorization header in the format:
Authorization: Bearer

Modified at 2023-08-15 03:06:39
Previous
Create-User
Next
Logout-User
Built with