Skip to main content
GET
/
v2
/
notify
/
management
/
subscriptions
/
{config_id}
/
phone_numbers
/
{phone_number}
Get subscription phone number status
curl --request GET \
  --url https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number} \
  --header 'Authorization: Bearer <token>'
{
  "config_id": "<string>",
  "phone_number": "<string>",
  "state": "SUB",
  "source": "MO_KEYWORD",
  "updated_at": "2023-11-07T05:31:56Z",
  "reason": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
config_id
string
required

The subscription configuration ID

​
phone_number
string
required

The phone number in E.164 format (e.g., +33612345678)

Response

OK

​
config_id
string
required

The subscription configuration ID.

Example:

"subcfg_01k8ap1btqf5r9fq2c8ax5fhc9"

​
phone_number
string<phone_number>
required

The phone number in E.164 format.

Example:

"+33612345678"

​
state
enum<string>
required

The subscription state:

  • SUB - Subscribed (user can receive marketing messages)
  • UNSUB - Unsubscribed (user has opted out)
Available options:
SUB,
UNSUB
​
source
enum<string>
required

How the subscription state was changed:

  • MO_KEYWORD - User sent a keyword (STOP/START)
  • API - Changed via API
  • CSV_IMPORT - Imported from CSV
  • CARRIER_DISCONNECT - Automatically unsubscribed due to carrier disconnect
Available options:
MO_KEYWORD,
API,
CSV_IMPORT,
CARRIER_DISCONNECT
​
updated_at
string<date-time>
required

The date and time when the subscription status was last updated.

Example:

"2024-01-01T12:00:00Z"

​
reason
string

Additional context about the state change (e.g., the keyword that was sent).

Example:

"STOP"