Update WhatsApp notification preferences

PATCH

/dashboard/v1/merchants/{merchantId}/{mode}/whatsapp/links/{id}

curl --request PATCH \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/whatsapp/links/example \
  --header 'Content-Type: application/json' \
  --cookie better-auth.session_token=<better-auth.session_token> \
  --data '{ "notifications": { "payment_succeeded": true } }'

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

id

required

string

Request Body^required

Media typeapplication/json

object

notifications

required

object

payment_succeeded

required

boolean

Example^generated

{
  "notifications": {
    "payment_succeeded": true
  }
}

Responses

200

Updated link

Media typeapplication/json

object

object

required

string

Allowed values: whatsapp_link

id

required

string

status

required

string

Allowed values: pending_approval active suspended revoked

wa_id

required

string

merchant_id

required

string

business_name

required

string

role

required

string

Allowed values: owner developer viewer

livemode

required

boolean

activated_at

required

string | null

notifications

required

object

payment_succeeded

required

boolean

Example

{
  "object": "whatsapp_link",
  "status": "pending_approval",
  "role": "owner"
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Sign-in required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}