Skip to content
Xaalis

Set or reset the shared owner payout PIN without a WhatsApp link

PUT
/dashboard/v1/merchants/{merchantId}/{mode}/agent-approvals/pin
curl --request PUT \
  --url https://api.xaalis.org/dashboard/v1/merchants/example/test/agent-approvals/pin \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --cookie better-auth.session_token=<better-auth.session_token> \
  --data '{ "pin": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
merchantId
required
string
mode
required
string
Allowed values: test live

Header Parameters

Section titled “Header Parameters”
idempotency-key
required

Required retry-safe key; reuse it only for the same operation and request body

string
>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
pin
required
string
/^\d{6}$/
Examplegenerated
{
  "pin": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

PIN effective time

Media typeapplication/json
object
object
required
string
Allowed values: whatsapp_payout_pin
effective_at
required
string
Example
{
  "object": "whatsapp_payout_pin"
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401”

Sign-in required

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Section titled “409”

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Section titled “429”

Rate limited; see Retry-After response header

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Section titled “503”

Rate limiter or service unavailable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}