Console

Record consent

.md

PUT

https://whatsapp.paaltech.org/api/v1/businesses/{external_id}/contacts/{id}/consents/{category}

Token ability: contacts.write · Authentication

Record an opt-in you collected (granted) or an opt-out (revoked). Business-initiated templates in a revoked category are refused with recipient_opted_out. Every change is kept in the contact's consent history and announced as contact.consent. Contacts also opt out of marketing and notifications by replying STOP, and back in with START.

Path parameters

external_id string required

Your own ID for the business (Multi-SKUUL - the tenant ID).

Max 191 characters. Pattern ^[A-Za-z0-9._:-]+$.

id integer required

category string required

One of: marketing, notifications, transactional.

Body parameters

status string required

One of: granted, revoked.

source string | null

Where it came from, e.g. signup_form (default api).

Max 24 characters.

note string | null

Max 191 characters.

Responses

200

The contact's consent and preferences now.

401

unauthenticated - missing, invalid, revoked or expired token

403

missing_ability, product_suspended or product_token_required

404

not_found - not yours, or does not exist

422

validation_failed - fields are invalid; see errors.

429

rate_limited - over 300 requests/minute for this product

Errors always look like {"error": {"code", "message"}} - see Errors and status codes.

Language

Credentials

Authorization Bearer $PAALCHAT_TOKEN

Request

cURL

curl --request PUT \
  --url 'https://whatsapp.paaltech.org/api/v1/businesses/presec/contacts/2/consents/category' \
  --header "Authorization: Bearer $PAALCHAT_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"status": "granted", "source": "signup_form"}'

const response = await fetch('https://whatsapp.paaltech.org/api/v1/businesses/presec/contacts/2/consents/category', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.PAALCHAT_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"status": "granted", "source": "signup_form"}),
});

const data = await response.json();
console.log(response.status, data);

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('PAALCHAT_TOKEN'))
    ->acceptJson()
    ->put('https://whatsapp.paaltech.org/api/v1/businesses/presec/contacts/2/consents/category', ['status' => 'granted', 'source' => 'signup_form']);

$data = $response->json();

import os
import requests

response = requests.put(
    "https://whatsapp.paaltech.org/api/v1/businesses/presec/contacts/2/consents/category",
    headers={"Authorization": f"Bearer {os.environ['PAALCHAT_TOKEN']}", "Accept": "application/json"},
    json={"status": "granted", "source": "signup_form"},
)

print(response.status_code, response.json())

require 'net/http'
require 'json'

uri = URI('https://whatsapp.paaltech.org/api/v1/businesses/presec/contacts/2/consents/category')
request = Net::HTTP::Put.new(uri)
request['Authorization'] = "Bearer #{ENV['PAALCHAT_TOKEN']}"
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
  {"status": "granted", "source": "signup_form"}
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, JSON.parse(response.body)

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	req, err := http.NewRequest("PUT", "https://whatsapp.paaltech.org/api/v1/businesses/presec/contacts/2/consents/category", strings.NewReader(`{"status": "granted", "source": "signup_form"}`))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAALCHAT_TOKEN"))
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

Try it with a test key

Only sk_test_ keys: requests reach your sandbox businesses, never real ones. The key is not saved.

Test key

external_id

id

category

JSON body

Response

Response

{
  "error": {"code": "unauthenticated", "message": "A valid product token is required."}
}

{
  "error": {
    "code": "missing_ability",
    "message": "This token does not have the ability this request needs."
  }
}

{"error": {"code": "not_found", "message": "Business not found."}}

{
  "error": {
    "code": "validation_failed",
    "message": "The external id field format is invalid. (and 1 more error)"
  },
  "errors": {
    "external_id": ["The external id field format is invalid."],
    "name": ["The name field is required."]
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and retry after the Retry-After header."
  }
}