Skip to content
Bottle

Change how Bottle handles WhatsApp messages

PATCH
/whatsapp
curl --request PATCH \
  --url https://example.com/whatsapp \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "createDrafts": true, "replyToCustomers": true, "answerQuestions": true, "allowReschedule": true, "allowCancel": true, "placeWhenConfirmed": true, "onlyTrialPhones": true, "trialPhones": [ "example" ] }'

Whether it makes draft orders, whether it replies to check them, and whether it only reads messages from a few numbers while you try it.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
createDrafts
boolean
replyToCustomers
boolean
answerQuestions
boolean
allowReschedule
boolean
allowCancel
boolean
placeWhenConfirmed
boolean
onlyTrialPhones
boolean
trialPhones
Array<string>
<= 200 items

Example generated

{
  "createDrafts": true,
  "replyToCustomers": true,
  "answerQuestions": true,
  "allowReschedule": true,
  "allowCancel": true,
  "placeWhenConfirmed": true,
  "onlyTrialPhones": true,
  "trialPhones": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

The connection

Media typeapplication/json
object
status
required
string
Allowed values: off disconnected connected
signup
required
object
appId
required
string
configId
required
string
displayPhone
required
string | null
verifiedName
required
string | null
createDrafts
required
boolean
replyToCustomers
required
boolean
answerQuestions
required
boolean
allowReschedule
required
boolean
allowCancel
required
boolean
placeWhenConfirmed
required
boolean
onlyTrialPhones
required
boolean
trialPhones
required
Array<string>
lastMessageAt
required
string | null format: date-time
lastError
required
string | null

Example 

{
  "status": "off"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

Conflicts with how things are now

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}