Create Opt In

POST

https://numueg.app/api/v1/stores/{store_id}/whatsapp/opt-ins

Last modified:2026-09-19 16:39:33

x-numu-scope:marketing:write

Merchant-side opt-in creation. Used by import flows / API integrations.

Phone is canonicalized inside the use-case; 422 on parse failure.
Idempotent: if an active opt-in already exists for (store, phone) the
existing row is returned with 201 (no new row written).

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Successful Response

Bodyapplication/json

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://numueg.app/api/v1/stores//whatsapp/opt-ins' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "phone": "string",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "source": "import"
}'

Response Example

201 - Example 1

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "phone": "string",
    "source": "checkout",
    "opted_in_at": "2019-08-24T14:15:22.123Z",
    "opted_out_at": "2019-08-24T14:15:22.123Z",
    "opt_out_reason": "inbound_stop_keyword"
}

Modified at 2026-09-19 16:39:33

List Opt Ins

Revoke Opt In